IBM Endpoint Manager Inspectors Reference

Terminology

Win: Windows
Lin: Red Hat and SUSE Linux
Sol: SUN Solaris
HPUX: Hewlett-Packard UNIX version
AIX: IBM AIX
Mac: Apple Macintosh
Ubu: Ubuntu/Debian
WM: Windows Mobile

The version (e.g. Lin:8.1) corresponds to the version of the IEM product (8.1) in which the inspector was introduced in the client on that platform.
The version number is not shown if it is less than 8.0.


Platform


Contents

Action Objects
Authorization Objects
Client Objects
Directory Services
Environment Objects
Filesystem Objects
application
bundle
component
country
datafork
device file
dictionary
dictionaryentry
domain
download storage folder
drive
fifo file
file
file content
file line
file section
file shortcut
file signature
file type
file version block
fileset
filesystem
filesystem object
folder
logical volume
logical volume manager
mode
mode_mask
osxvalue
preference
resfork
socket file
stage
strverscmp version
symlink
version
version with multiplicity
volume
volume group
xml dom node
Firewall Objects
Fixlet Objects
Formatting Objects
Installed System Software
Introspectors
License Objects
Microsoft IIS Metabase Objects
Miscellaneous
Networking Objects
Power Objects
Primitive Objects
Registry Objects
Session Objects
Session Statistics
Site Objects
SMBIOS objects
System Objects
Task Objects
User Objects
Windows Mobile Device Objects
WMI Objects
World Objects

IBM Endpoint Manager wiki

Filesystem Objects

This chapter covers the keywords for extracting information from the file system, like files, drives, pathnames, folders, etc. It also includes the keywords needed to identify and compare version information of files and patches.For more information on special Windows folders, see the Resources section at the end of this guide.

filesystem

The filesystem object can be used to inspect various aspects of mounted file systems, including the format of the file system. Here are some of the possible format types:affsext, ext2, ext2_oldhpfsisominix, minix_30, minix2, minix2_30 msdos ncpnfsprocsmbxenixsysv4, sysv2cohufsxia

Creation Methods

DeclarationDescriptionPlatforms (?)
driveIterates through all valid drives on the system. Typically used to return a list of the drives (volumes, filesystems) on the client computer. On Windows computers, this returns a <drive> object.On *nix computers, this returns a <filesystem> object.Drives, volumes and filesystems are treated the same on the Macintosh and return a <volume> type.

Example:
names of drives - Returns a list of drives, eg., C:, D:, etcetera.
Lin, Sol, HPUX, AIX, Ubu:8.1
drive <string>Returns the drive associated with the pathname specified by <string>. On Windows computers, this returns a <drive> object.On Macintosh computers, this returns a <volume> object.On *nix computers, this returns a <filesystem> object.Lin, Sol, HPUX, AIX, Ubu:8.1
filesystemReturns the volume corresponding to the filesystem. Typically used to return a list of the filesystems (drives, volumes) on the client computer. Drives, volumes and filesystems are treated the same on the Macintosh and return a <volume> type.

Example:
names of filesystems - Returns the names of the mounted file systems.
Lin, Sol, HPUX, AIX, Ubu:8.1
filesystem <string>Returns the filesystem corresponding to the specified name. On a Macintosh, this Inspector returns a <volume> object.Lin, Sol, HPUX, AIX, Ubu:8.1
drive of <file>Returns the drive associated with the specified file. On Macintosh computers, this returns a <volume> object.On *nix computers, this returns a <filesystem> object.Win, Lin, Sol, HPUX, AIX, Ubu:8.1
stationery of <file>Returns TRUE if the file is a stationery file.Mac, Ubu:8.1
filesystem of <file>Returns the UNIX filesystem flag for the given file. On a Macintosh, this returns a <volume> object.Lin, Sol, HPUX, AIX, Ubu:8.1
drive of <folder>Returns the drive associated with the specified folder.On Macintosh computers, this returns a <volume> object.On *nix computers, this returns a <filesystem> object.Lin, Sol, HPUX, AIX, Ubu:8.1
filesystem of <folder>Returns the filesystem on which the folder resides. On a Macintosh, this Inspector returns a <volume> object.Lin, Sol, HPUX, AIX, Ubu:8.1
drive of <symlink>Returns the drive associated with the specified symlink as a <filesystem> object.Lin, Sol, HPUX, AIX, Ubu:8.1
filesystem of <symlink>Returns the filesystem on which the symlink resides.Lin, Sol, HPUX, AIX, Ubu:8.1
drive of <device file>Returns the drive associated with the specified device file.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
filesystem of <device file>Returns the filesystem object corresponding to the specified device file.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
drive of <fifo file>Returns the drive associated with the specified FIFO (named pipe) file.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
filesystem of <fifo file>Returns the filesystem object corresponding to the specified FIFO file.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
drive of <socket file>Returns the drive associated with the specified socket file.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
filesystem of <socket file>Returns the filesystem object corresponding to the specified socket file.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
volume of <filesystem><string>

Plural: volumes
This is a <Plain> property inspector that takes a <filesystem> type and returns a <volume> type.Ubu:9.0, Lin:9.0, HPUX:9.0, AIX:9.0, Sol:9.0
file count of <filesystem><integer>

Plural: file counts
Returns the total number of files that may be saved on this filesystem.Lin, Sol, HPUX, AIX, Ubu:8.1
free file count of <filesystem><integer>

Plural: free file counts
Returns the number of files available on this filesystem.Lin, Sol, HPUX, AIX, Ubu:8.1
free percent of <filesystem><integer>

Plural: free percents
Returns the percentage of the file system currently available.Lin, Sol, HPUX, AIX, Ubu:8.1
free space of <filesystem><integer>

Plural: free spaces
Returns the number of bytes on this filesystem.Lin, Sol, HPUX, AIX, Ubu:8.1
logical volume of <filesystem><logical volume>

Plural: logical volumes
On an AIX system, returns the logical volume corresponding to the given filesystem.AIX
name of <filesystem><string>

Plural: names
Returns the mount point of the filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1
size of <filesystem><integer>

Plural: sizes
Returns the total number of bytes on this file system (same as total space).Lin, Sol, HPUX, AIX, Ubu:8.1
total space of <filesystem><integer>

Plural: total spaces
Returns the total number of bytes on this file system (same as size).Lin, Sol, HPUX, AIX, Ubu:8.1
type of <filesystem><string>

Plural: types
Returns the filesystem format type, as listed in the type header.Lin, Sol, HPUX, AIX, Ubu:8.1
used file count of <filesystem><integer>

Plural: used file counts
The number of files in use on this filesystem.Lin, Sol, HPUX, AIX, Ubu:8.1
used percent of <filesystem><integer>

Plural: used percents
Returns the percentage of the file system currently in use.Lin, Sol, HPUX, AIX, Ubu:8.1
used space of <filesystem><integer>

Plural: used spaces
Returns the number of bytes on this filesystem currently in use.Lin, Sol, HPUX, AIX, Ubu:8.1

filesystem object

The <filesystem object> Inspectors provide handles for the various objects available in the file system.

Creation Methods

DeclarationDescriptionPlatforms (?)
applicationThis Mac Inspector recursively finds all applications (bundles) and executables under the /Applications directory, as well as all of those under the Applications directories of all local users of the machine.Mac
application <string>Returns the named applications (bundles) and executables as filesystem objects.Mac
hfs item <string>Returns a filesystem object with the specified item name. The Macintosh has two different path types it can output. HFS (Hierarchical File System) was an OS9 format where the path separator was ':' and there were multiple roots (each volume). POSIX has superseded HFS and is single rooted with '/' as a separator. All of the Macintosh Inspectors that are not otherwise specified default to the POSIX version.Mac:8.0
item <string>Returns a filesystem object with the given name, either a file or a folder.Mac:8.0
posix item <string>Returns a filesystem object with the given name, either a file or a folder, using POSIX formatting.Mac:8.0
sibling item <string> of <filesystem object>The named sibling of a filesystem object (file, folder).Mac
application of <folder>Recursively finds executables in the supplied folder, returning a list of "application" objects, which are basically filesystem_objects.

Example:
applications of folder "/Users/fizzle/bin" - Returns a list of applications in the specified directory, such as /Users/fizzle/bin/p4, /Users/fizzle/bin/mylocaltool.
Mac
find item <string> of <folder>Returns the filesystem objects matching the item wildcard string of the given folder. Macintosh 'items' are analogous to files and folders on other systems. A wildcard string uses an asterisk to stand for any number of characters (incuding zero), and a question mark to stand for exactly one character. Thus A??.txt would match All.txt and AXE.txt but not all.txt or a.txt.Mac:8.0
hfs relative item <string> of <folder>Returns a filesystem object with the given wildcard name from the specified folder, using HFS format. A wildcard string uses an asterisk to stand for any number of characters (incuding zero), and a question mark to stand for exactly one character. Thus A??.txt would match All.txt and AXE.txt but not all.txt or a.txt.Mac:8.0
item <string> of <folder>Returns the named item (file or folder) from the specified folder.Mac
item ending in <string> of <folder>Returns a list of items (files/folders) ending in "xxxx". Typically used to identify a dotted extension. Equivalent to a wildcard search for "*xxxx".Mac
item of <folder>Returns a list of the items (file or folder) in the specified folder.

Example:
names of items of applications folder - Returns a list of applications, such as DS_Store, .localized, AddressBook.app, AppleScript, Calculator.app, Chess.app, DVD Player.app, etc....
Mac
posix relative item <string> of <folder>Returns a filesystem object with the given relative item name from the specified folder, using POSIX format.Mac:8.0
relative item <string> of <folder>Returns a filesystem object with the given relative item name from the specified folder, using POSIX format.Mac:8.0

Operators

DeclarationReturn TypeDescriptionPlatforms (?)
<filesystem object> = <filesystem object><boolean>Compares two Macintosh file system objects.Mac

Properties

DeclarationReturn typeDescriptionPlatforms (?)
change time of <filesystem object><time>

Plural: change times
Returns the last time the specified filesystem object was changed by either writing it or setting its inode information.Ubu:8.1, Lin, HPUX, AIX, Sol
<filesystem object> as device file<device file>Returns a device file or nothing (if the filesystem object specified is not a device file).Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
<filesystem object> as fifo file<fifo file>Returns a FIFO file or nothing (if the filesystem object specified is not a FIFO file).Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
<filesystem object> as file<file>Returns a file or nothing (if, for example, the filesystem object was a folder).Mac
<filesystem object> as folder<folder>Returns a folder or nothing.Mac
<filesystem object> as socket file<socket file>Casts a given filesystem object as a socket file.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
<filesystem object> as string<string>Casts a filesystem object as a string.Win:8.0, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
<filesystem object> as symlink<symlink>Casts a link in the form of a file into a symlink.Lin, Sol, HPUX, AIX, Ubu:8.1
accessed time of <filesystem object><time>

Plural: accessed times
When the filesystem object (file or folder) was last accessed. Some file systems maintain this property.Win, Lin, Sol, HPUX, AIX, WM, Ubu:8.1
ancestor of <filesystem object><folder>

Plural: ancestors
Returns all ancestor folders (recursive parent folders) of the given filesystem object (file or folder).Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
archive of <filesystem object><boolean>

Plural: archives
Returns TRUE if the Archive bit is turned on for the specified file or folder (filesystem object). This bit is often used by backup software.Win, WM
backup time of <filesystem object><time>

Plural: backup times
The date of the last backup of the specified filesystem object (such as a file or folder). This corresponds to what is shown in the "Get Info" box for this object.Mac
bundle version of <filesystem object><version>

Plural: bundle versions
Returns the version of the filesystem object corresponding to the CFBundleVersion string, as distinct from the CFBundleShortVersionString.Mac
compressed of <filesystem object><boolean>

Plural: compresseds
Returns TRUE if the file or folder (filesystem object) has been compressed.Win, WM
creation time of <filesystem object><time>

Plural: creation times
The date and time of creation of the specified file or folder. This corresponds to what is shown in the "Get Info" box.Win, Mac, WM
drive of <filesystem object><drive>

Plural: drives
Returns the drive associated with the specified file or folder (filesystem object).Win, WM
gid of <filesystem object><integer>

Plural: gids
Returns the group ID of the given filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1
group execute of <filesystem object><boolean>

Plural: group executes
Returns TRUE if the group execute flag is set for the given filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1
group mask of <filesystem object><integer>

Plural: group masks
Returns the group permission mask of the given filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1
group name of <filesystem object><string>

Plural: group names
Returns the group name of the given filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1
group read of <filesystem object><boolean>

Plural: group reads
Returns TRUE if the group read flag is set for the given filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1
group write of <filesystem object><boolean>

Plural: group writes
Returns TRUE if the group write flag is set for the given filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1
hfs path of <filesystem object><string>

Plural: hfs paths
Returns the path to a filesystem object in HFS terms (colons as delimiters).Mac
hidden of <filesystem object><boolean>

Plural: hiddens
Returns TRUE if the file or folder (filesystem object) is marked as hidden.Win, WM
link count of <filesystem object><integer>

Plural: link counts
Returns an integer corresponding to the number of hard links attached to the specified filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1
location of <filesystem object><string>

Plural: locations
Returns the name of the directory in which the file or folder (filesystem object) is located.Win, Lin, Sol, HPUX, AIX, WM, Ubu:8.1
mode of <filesystem object><mode>

Plural: modes
Returns the permissions mode for the given filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1
modification time of <filesystem object><time>

Plural: modification times
The date and time of latest modification of the file. This corresponds to what is shown in the "Get Info" box.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
name of <filesystem object><string>

Plural: names
This returns the name of the file or folder.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
normal of <filesystem object><boolean>

Plural: normals
Returns TRUE if the file or folder (filesystem object) is 'normal'.Win, WM
offline of <filesystem object><boolean>

Plural: offlines
Returns TRUE if the file or folder (the filesystem object) is marked as 'offline'.Win, WM
other execute of <filesystem object><boolean>

Plural: other executes
Returns TRUE if others (not in the group) have execute permissions on the given filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1
other mask of <filesystem object><integer>

Plural: other masks
Returns the other (not in the group) mask as a 3-bit integer corresponding to rwx permissions for the specified filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1
other read of <filesystem object><boolean>

Plural: other reads
Returns TRUE if others (not in the group) have read permissions on the given filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1
other write of <filesystem object><boolean>

Plural: other writes
Returns TRUE if others (not in the group) have write permissions on the given filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1
parent folder of <filesystem object><folder>

Plural: parent folders
The folder containing the specified file or folder.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
pathname of <filesystem object><string>

Plural: pathnames
Returns the full pathname of the specified file or folder (filesystem object) as a string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
posix path of <filesystem object><string>

Plural: posix paths
The POSIX file path for the file or folder.Mac
readonly of <filesystem object><boolean>

Plural: readonlys
Returns TRUE if the file or folder (the filesystem object) is marked as read-only.Win, WM
setgid of <filesystem object><boolean>

Plural: setgids
Returns TRUE if the setgid (group ID) bit is set for the specified filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1
setuid of <filesystem object><boolean>

Plural: setuids
Returns TRUE if the setuid (user ID) bit is set for the specified filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1
sibling file <string> of <filesystem object><file>

Plural: sibling files
A named property. A file in the same folder as the specified file object.Mac
sibling folder <string> of <filesystem object><folder>

Plural: sibling folders
A named property. A folder in the same folder as the specified file object.Mac
sibling item <string> of <filesystem object><filesystem object>

Plural: sibling items
The named sibling of a filesystem object (file, folder).Mac
system of <filesystem object><boolean>

Plural: systems
Returns TRUE if the file or folder (the filesystem object) is marked as a system folder.Win, WM
temporary of <filesystem object><boolean>

Plural: temporarys
Returns TRUE if the file or folder (the filesystem object) is marked as a temporary folder.Win, WM
uid of <filesystem object><integer>

Plural: uids
The user ID of the user who owns this filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1
user execute of <filesystem object><boolean>

Plural: user executes
Returns TRUE if the owner (user) has execute permissions on the given filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1
user mask of <filesystem object><integer>

Plural: user masks
Integer representing user permissions (3 bit mask, RWX) on the specified filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1
user name of <filesystem object><string>

Plural: user names
Returns the owner (user) name of the specified filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1
user read of <filesystem object><boolean>

Plural: user reads
Returns the owner (user) read permissions for the specified filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1
user write of <filesystem object><boolean>

Plural: user writes
Returns the owner (user) write permissions for the specified filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1
version of <filesystem object><version>

Plural: versions
This returns the version information from "vers" resource 1 of the file. It is usually present in applications, and may exist in data files as well. It corresponds to what appears in the "Get Info" box for the specified filesystem object.Mac

file

For each file in the file system, you can create a corresponding file object and inspect its properties. Inspectors are also provided to look at version data of executable files.Note: File systems that do not maintain the creation or last accessed times will often return the last modification time when queried for the creation or last accessed times or files. Modification times are preserved when files are copied. Thus, it is not uncommon to see a file that appears to have been modified before it was created.

Creation Methods

DeclarationDescriptionPlatforms (?)
active device fileUnder Windows NT, returns a list of file objects corresponding the list returned from the Windows NT EnumDeviceDrivers() function.Win
active device file <string>Under Windows NT, returns a file object corresponding to the name provided. See file.Win
default web browserCreates an object corresponding to the default web browser. This is a *nix inspector; it will fail gracefully on other operating systems instead of generating an error.Lin, Sol, HPUX, AIX, Ubu:8.1
download file <string>This inspector is available in relevance subsitution action processing. It returns a file object with the given name from the named folder or the download folder. This is equivalent to 'file "name" of download folder'. The file should exist or the result will not exist.

Example:
wait "{pathname of download file "update.exe"}" - In an Action script, this line causes the BES Client to perform relevance substitution to compute the full path to the downloaded file (previously collected by a download command in the same Action script). After relevance substitution, the Client launches the specified executable and waits for it to complete before moving on to other Action lines.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
file <string>Returns a filesystem object corresponding to the full pathname provided in <string>.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
file <symlink>Returns the file pointed to by the specified symlink. If the file doesn't exist, this Inspector will throw a 'non-existent object' error.Lin, Sol, HPUX, AIX, Ubu:8.1
hfs file <string>Returns the hierachical file system (HFS) file specified by <string>.Mac
posix file <string>Returns the POSIX file specified by <string>.Mac
system file <string>Returns a file object corresponding to the relative pathname provided.Win, WM
system ini device fileReturns a list of file objects corresponding to all the device files loaded as a result of a device= lines of the system.ini file. See file.Win
system ini device file <string>Returns a file object corresponding to a device file loaded as a result of a device= line of the system.ini file.Win
windows file <string>Returns a file object corresponding to the relative pathname (within the Windows folder) provided. See file.

Example:
exists windows file "command.com" - Verifies the existence of the named file in the Windows folder.
Win, WM
x32 file <string>Returns an object corresponding to a 32 bit file with name specified by <string>.Win
x64 file <string>Returns an object corresponding to a 64 bit file with pathname specified by <string>. On a 32-bit computer, this is equivalent to a normal file Inspector, but on a 64-bit machine, this Inspector returns an object that has filesystem redirection disabled.Win
<registry key value> as system x32 fileIf the value contains a string and the string points to an file, a file object is returned. Relative paths are interpreted relative to the x32 system folder. Win:9.0
<registry key value> as system x64 fileIf the value contains a string and the string points to an file, a file object is returned. Relative paths are interpreted relative to the x64 system folder. Win:9.0
<registry key value> as fileIf the data stored in the value is a string and it is the full pathname of a file that exists on disk, the file object is returned.Win, WM
<registry key value> as system fileIf the data stored in the value is a string and it is a relative pathname from the system folder of a file that exists on disk, the corresponding file object is returned.Win, WM
<filesystem object> as fileReturns a file or nothing (if, for example, the filesystem object was a folder).

Example:
application "iTunes.app" as file - Fails because that is in fact a folder.
Mac
sibling file <string> of <filesystem object>A named property. A file in the same folder as the specified file object.

Example:
exists sibling file "iTunes.app" of application "iChat.app" - Returns TRUE if both applications are in the same folder.
Mac
descendant of <folder>Returns a list of all the descendant files of the specified folder.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
file <string> of <folder>Returns a file object for the named file located in the folder.

Example:
exists file whose (name of it contains ".pdf") of folder "name" - Returns TRUE if some file in the folder has a name including the string ".pdf".
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
file ending in <string> of <folder>Returns a list of files ending in "xxxx". Typically used to identify a dotted extension. Equivalent to a wildcard search for "*xxxx".

Example:
files ending in ".a" of folder "/usr/lib" - Returns a list of files with the specified ending, such as: /usr/lib/libcpp_kext.a, /usr/lib/libfl.a, /usr/lib/libioabc.a, and others.
Mac
file of <folder>Iterates through the files of a folder returning file objects. When combined with a whose clause you can select files with specific properties. See file.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
find file <string> of <folder>Iterates through the files of a folder returning file objects whose name matches the wildcard string provided in the name parameter. A wildcard string uses an asterisk to stand for any number of characters (incuding zero), and a question mark to stand for exactly one character. Thus A??.txt would match All.txt and AXE.txt but not all.txt or a.txt. See example below.

Example:
Number of find files "siteico*.bmp" of client folder of current site = 3 - Returns TRUE if there are 3 files matching the wildcard pattern siteico*.bmp.

Example:
names of find files "*.exe" of windows folder - Returns a list of the names of all the executable programs in the Windows folder.
Win, Lin, Sol, HPUX, AIX, Mac:8.0, WM, Ubu:8.1
relative file <string> of <folder>Returns the file with the path specified by <string> relative to the given <folder>.

Example:
relative file "Safari.app/Contents/MacOS/Safari" of applications folder - Returns the concatenation of the specified folder and the given path, /Applications/Safari.app/Contents/MacOS/Safari.
Mac
relative hfs file <string> of <folder>Returns the HFS file with the path specified by <string> relative to the given <folder>.Mac
relative posix file <string> of <folder>Returns the POSIX file with the path specified by <string> relative to the given <folder>.Mac
<symlink> as fileConverts a symlink object into the file it points to.Lin, Sol, HPUX, AIX, Ubu:8.1
file of <service>Returns a file object corresponding to the specified <service>.Win
image file of <process>Returns a file object representing the image file used to launch the process. In some cases, this subproperty may not exist. For example, the "System" process does not have an image file.Win:8.0
masthead of <site>Each site has a masthead, and the masthead is saved into the site data folder upon successful creation. This property returns a file object that corresponds to the copy in the site data folder.

Example:
modification time of masthead of current site < time "4 Aug 1997 01:00 pdt" - Returns TRUE if the masthead of the current site is older than the specified date.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
md5 of <file><string>

Plural: md5s
Returns the md5 of the file, hex encoded as a stringUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
sha2_224 of <file><string>

Plural: sha2_224s
Returns the sha2-224 of the file, hex encoded as a stringUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
sha2_256 of <file><string>

Plural: sha2_256s
Returns the sha2-256 of the file, hex encoded as a stringUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
sha2_384 of <file><string>

Plural: sha2_384s
Returns the sha2-384 of the file, hex encoded as a stringUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
sha2_512 of <file><string>

Plural: sha2_512s
Returns the sha2-512 of the file, hex encoded as a stringUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
creator of <file><file signature>

Plural: creators
This refers to the four-character identifier used in all MacOS files. The creator tells what application should open the specified file.Mac
<file> as string<string>Creates a string containing the full pathname of the specified file. See <file>.Win, Lin, Sol, HPUX, AIX, WM
alias of <file><boolean>

Plural: aliases
Returns TRUE if the file is an alias for another file.Mac
array of <file><array>

Plural: arrays
This Inspector creates an OSXArray from the specified XML Data file.Mac:8.1
byte <integer> of <file><integer>

Plural: bytes
Returns the numeric value of the byte located at the offset specified by number within the file. Byte 0 of the file is the first byte.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
content of <file><file content>

Plural: contents
Returns an object that can be used to search for a string in the file. See content.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
type of <file><file type>

Plural: types
This refers to the four-character identifier used in all MacOS files. The type describes the sort of file it is.Mac
data fork of <file><datafork>

Plural: data forks
Returns information about the data fork of the specified file.Mac
dictionary of <file><dictionary>

Plural: dictionaries
Returns the dictionary object for the specified file.Mac
drive of <file><filesystem>

Plural: drives
Returns the drive associated with the specified file. On Macintosh computers, this returns a <volume> object.On *nix computers, this returns a <filesystem> object.Win, Lin, Sol, HPUX, AIX, Ubu:8.1
stationery of <file><filesystem>

Plural: stationeries
Returns TRUE if the file is a stationery file.Mac, Ubu:8.1
drive of <file><volume>

Plural: drives
Returns the drive associated with the specified file.On Macintosh computers, this returns a <volume> object.On *nix computers, this returns a <filesystem> object.Mac
executable file format of <file><string>

Plural: executable file formats
Returns a four-byte string containing the format specifier for the specified file.Win, WM
file version of <file><version>

Plural: file versions
Returns the file version extracted from the file's resource block. See version.Win, WM
filesystem of <file><filesystem>

Plural: filesystems
Returns the UNIX filesystem flag for the given file. On a Macintosh, this returns a <volume> object.Lin, Sol, HPUX, AIX, Ubu:8.1
filesystem of <file><volume>

Plural: filesystems
Returns the UNIX filesystem flag for the given file. On a Macintosh, this returns a <volume> object.Mac
first raw version block of <file><file version block>

Plural: first raw version blocks
Returns the first version block directly from a PE file. If the first block is sufficient for your purposes, use this version inspector for best speed.Win, WM
key <string> of <file><string>

Plural: keys
Returns a key and its value from the given structured text file. It iterates over lines that start with the key name (as specified by <string>) followed by an = or : character. When searching, white space is ignored.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
length of <file><integer>

Plural: lengths
The total length of the data and resource forks.Mac
line <integer> of <file><file line>

Plural: lines
Returns the nth line (specified by <integer>) from the given file.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
line containing <string> of <file><file line>

Plural: lines containing
Returns all lines from the given file that contain the specified string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
line of <file><file line>

Plural: lines
Iterates over all the lines of the specified file. Note that the lines are truncated to 1023 characters.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
line starting with <string> of <file><file line>

Plural: lines starting with
Same as line <string> of <file>, returns the lines of the given file that start with the specified string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
locked of <file><boolean>

Plural: lockeds
Returns TRUE if the file is locked.Mac
only raw version block of <file><file version block>

Plural: only raw version blocks
Returns the only version block directly from a PE file.Win, WM
only version block of <file><file version block>

Plural: only version blocks
Most files only have 1 version block. This property allows language independent access when there is only one version block present. The result is the same as 'version block 1'.Win, WM
pem encoded certificate of <file><x509 certificate>

Plural: pem encoded certificates
Reads and returns the certificate from a file in the PEM format. This can be used to analyze encryption credentials on decrypting relays or root servers.Win, WM
product version of <file><version>

Plural: product versions
Returns the product version extracted from the file's resource block. See version.Win, WM
raw file version of <file><version>

Plural: raw file versions
Returns the file version directly from a PE file.Win, WM
raw product version of <file><version>

Plural: raw product versions
Returns the product version directly from a PE file.Win, WM
raw version block <integer> of <file><file version block>

Plural: raw version blocks
Returns the numbered version block directly from a PE file.Win, WM
raw version block <string> of <file><file version block>

Plural: raw version blocks
Returns the named version block directly from a PE file.Win, WM
raw version block of <file><file version block>

Plural: raw version blocks
Returns the version block directly from a PE file.Win, WM
raw version of <file><version>

Plural: raw versions
Returns the version directly from a PE file.Win, WM
resource fork of <file><resfork>

Plural: resource forks
Returns information about the resource fork of the file.Mac
section <string> of <file><file section>

Plural: sections
Returns a named section of a file. Useful for locating sections of 'ini' files. Section names are delimited by square bracket characters '[section name]'. See examples below.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
security descriptor of <file><security descriptor>

Plural: security descriptors
Specifies the security descriptor associated with the specified file.Win
sha1 of <file><string>

Plural: sha1s
Returns the sha1 checksum of the file hex encoded as a 40 character long string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
shortcut of <file><file shortcut>

Plural: shortcuts
Returns the properties and locates the target of a file shortcut:pathname (string)start in pathname (string)argument string (string)icon pathname (string)icon index (integer).Win
size of <file><integer>

Plural: sizes
Returns the size in bytes of a file.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
variable of <file><string>

Plural: variables
Returns the names of variables contained in an INF style file, in the format [section].name=value.Win, Lin, Sol, HPUX, AIX, WM, Ubu:8.1
version <integer> of <file><version>

Plural: versions
Returns the nth version information from the "vers" resource of the given file. Typically n=1, but other information may be stored in "vers" resources greater than 1.Mac
version block <integer> of <file><file version block>

Plural: version blocks
You can identify the particular version block you want to access by ordinal number.Win, WM
version block <string> of <file><file version block>

Plural: version blocks
You can identify the particular version block you are looking up by name. The name you provide should match the id string of the version block.Win, WM
version block of <file><file version block>

Plural: version blocks
Iterates through the version blocks of a file.Win, WM
version of <file><version>

Plural: versions
Synonym for file version of <file>.Win, Mac, WM
visible of <file><boolean>

Plural: visibles
Returns TRUE if the file is visible.Mac
volume of <file><volume>

Plural: volumes
The volume containing the file.Mac
xml document of <file><xml dom document>

Plural: xml documents
Returns an XML Document Object Model (DOM) for the specified file.Win, WM

application

Application objects derive from file objects. Therefore, application objects inherit all of the properties of the file object. This means that you can inspect properties such as 'modification time' or 'Product Version' of an application just as you would a file. See the properties of a file object for a complete list of these. The real power and primary purpose of the application object is their creation. The creation methods are optimized in anticipation of the importance of this object.Note: See File' for a list of the Application properties. Folder and file names may be case sensitive. Use "as uppercase" or "as lowercase" if you don't know the actual case when making comparisons. For Windows versions of these Inspectors, a properly installed application will register itself with the operating system. It does this by creating a registry sub-key usually named after the executable. The regapp Inspector uses the default value of this sub-key as a string that is the full pathname of the executable.

Creation Methods

DeclarationDescriptionPlatforms (?)
application <string>Returns an application for the name provided. On a Macintosh, this Inspector may return a filesystem object.

Example:
application "qna.exe" of parent folder of application "bigfix.exe" of the registry - Using the application of folder creation method, this example locates the 'sibling' application qna.exe provided it exists in the same folder in which the registered application 'bigfix.exe' is installed.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
default web browserReturns the application currently associated with HTML files. This is a Windows Inspector; it will fail gracefully under other operating systems, rather than generate an error. When the agent is a service under windows, it runs in the LocalSystem context.

Example:
default web browser - Returns a value such as: "iexplore.exe" "" "" "" "".
Win
recent applicationReturns all the application objects that have recently been executing on the machine. See application.Win, Lin, Sol:8.1, WM, Ubu:8.1
recent application <string>Returns an application for the name provided it has recently executed. The name is assumed to be the last part of an executable file name.Win, Lin, Sol:8.1, WM, Ubu:8.1
regappThis Inspector returns the applications available to the Client. On Windows systems, this Inspector returns all the application objects defined under the 'App Paths' key of the registry. On a Macintosh, it recursively finds all applications (bundles) and executables under the /Applications directory, as well as all of those under the Applications directories of all local users of the machine. It returns a <filesystem object>. This Inspector is the same as application, and is included for compatibility with Windows.

Example:
names of regapps - Primarily used in QnA to obtain lists of applications installed under the "app path" key of the registry.
Win, Mac, WM
regapp <string>Returns an application object for the name provided. See application and regapp.

Example:
byte 0 of regapp "bigfix.exe" = 77 - TRUE if the first byte in the specified file is ASCII 77.

Example:
regapp "IEXPLORE.EXE" - Returns the application object associated with the named registry key. Checks to see if the executable exists and if so, returns the application object. Case is ignored.
Win, WM
running applicationReturns all the application objects that are currently executing on the machine. See application.

Example:
exists running application whose (name of it as lowercase is "winword.exe") - Returns TRUE if Microsoft Word is currently executing.
Win, Lin, Sol:8.1, WM, Ubu:8.1
running application <string>Returns an application for the name provided it is currently executing. The name is assumed to be the last part of an executable file name.Win, Lin, Sol:8.1, WM, Ubu:8.1
x32 application <string>Returns an object corresponding to the 32-bit application specified by <string>.Win
x64 application <string>Returns an object corresponding to the 64-bit application specified by <string>. On a 32-bit computer, this is equivalent to a normal application Inspector, but on a 64-bit machine, this Inspector returns an object that has filesystem redirection disabled.Win
application <string> of <registry>Returns an application object matching name provided. See application.Win, WM
application of <registry>Iterates through the properly installed applications. See application.

Example:
name of application of key ".txt" of key "HKEY_CLASSES_ROOT" of the registry = "NOTEPAD.EXE" - True when text files are to be opened with notepad.exe on the current machine.
Win, WM
application <string> of <registry key>Returns the application associated with the named command. Normally used with a sub-key of key HKEY_CLASSES_ROOT whose name is a file type.

Example:
application "print" of key "HKEY_CLASSES_ROOT\.txt" of registry - Returns the application designated to print the files with ".txt" extensions.

Example:
application "bigfix.exe" of the registry as string - Results in a string of the form "BigFix.exe" "1.0.32.0" "BigFix Client Application" "1.0.32.0" "BigFix Inc.".
Win, WM
application of <registry key>Returns the application associated with the "open" command. Normally used with a sub-key of key HKEY_CLASSES_ROOT whose name is a file extension.

Example:
name of application of key ".txt" of key "HKEY_CLASSES_ROOT" of the registry = "NOTEPAD.EXE" - True when text files are to be opened with notepad.exe on the current machine.
Win, WM
<registry key value> as applicationIf the data stored in the value is a string and it is the full pathname of an application that exists on disk, the application object is returned.Win, WM
application <string> of <folder>Returns an application object for the named file located in the folder. See application.

Example:
exists application "notepad.exe" of the windows folder - Using the application of folder creation method, this example locates the notepad application provided it exists in the Windows folder.
Win, Lin, Sol, HPUX, AIX, WM, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
inspectability of <application><boolean>

Plural: inspectabilities
Win:8.2
task name of <application><string>

Plural: task names
Win:8.2
virtualizer of <application><string>

Plural: virtualizers
Win:8.2

folder

For every folder that exists in the file system, you can create a folder object. These Inspectors allow you to examine dozens of properties of folder objects. On the Macintosh, there are dozens of specialized folders; access to them depends on the domain. If the domain is not specified, it defaults to the system domain.

Creation Methods

DeclarationDescriptionPlatforms (?)
csidl folder <integer>Returns the csidl folder corresponding to the specified integer. The windows SHGetSpecialFolderLocation API is used to look up paths to special folders, which are identified by passing the specified integer as the second argument of the API call. These values and their meaning are described in the windows ShlObj.h include file found in the development sdk.Note that some of these folders do not exist in the Local System context.

Example:
pathname of csidl folder 26 - Returns the path corresponding to CSIDL folder 26 (the application shared data folder, CSIDL_APPDATA).
Win, WM
download folderThis inspector is available in relevance subsitution action processing. When the action is active, this inspector returns a folder object of __Download\, otherwise it returns a folder object of __Global\sitename\actionid\named. This inspector is designed for the prefetch process of action execution. Macintosh Note: Prior to version 7.2, this Inspector referred to the system download folder on the Macintosh. That Inspector is referred to as ISS Download as of version 7.2.

Example:
wait "{pathname of file "update.exe" of download folder}" - In an Action script, this line causes the BES Client to perform relevance substitution to compute the full path to the downloaded file (previously collected by a download command in the same Action script). After relevance substitution, the Client launches the specified executable and waits for it to complete before moving on to other Action lines.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.2
folder <string>Returns a folder object for the name provided. See drive.

Example:
exists folder "c:\program files" - Checks for the existence of the program files folder.

Example:
exists folder "/usr/lib" - Checks for the existence of the usr/lib folder.

Example:
exists folder "/usr/lib" - Checks for the existence of the usr/lib folder.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
folder <symlink>Returns the folder pointed to by the specified symlink.Lin, Sol, HPUX, AIX, Ubu:8.1
hfs folder <string>Returns the hierachical file system (HFS) folder specified by <string>.Mac
install folder <integer>Returns a folder object corresponding to the number provided. The placement of some system folders can be found using numbers that have been associated with those folders. See folder.

Example:
install folder 11 - Returns a folder object for system folder identified with this number.
Win, WM
internet plugins folderReturns the folder object corresponding to the internet plugins.Mac
iss download folderThe Macintosh download folder. This Inspector was previously labeled "download," which now refers to a world object that performs dynamic downloading.Mac
posix folder <string>Returns the POSIX folder specified by <string>.Mac
root folderReturns the folder corresponding to '/'.Lin, Sol, HPUX, AIX, Ubu:8.1
system wow64 folderReturns a filesystem object corresponding to a "Windows On Windows 64" system folder, which does not exist on 32-bit Windows. You can find out more about the WOW64 system folder at the Microsoft site: http://msdn.microsoft.com/library/default.asp?url=/library/en-us/sysinfo/base/getsystemwow64directory.asp.Win, WM
system x32 folderReturns a filesystem object corresponding to a 32-bit system folder. On a 32-bit machine, this is equivalent to the normal system folder.Win, WM
system x64 folderReturns a filesystem object corresponding to a 64-bit system folder. This is the same as the system folder, but with file system redirection disabled. For more information about file redirection, see the Microsoft site http://msdn.microsoft.com/library/default.asp?url=/library/en-us/win64/win64/file_system_redirector.asp.Win, WM
windows folderReturns a folder object of the Windows folder This is operating system dependent. Under Win98 this is usually c:\Windows.Win, WM
x32 folder <string>Returns a filesystem object corresponding to a 32-bit folder.Win
x64 folder <string>Returns a filesystem object corresponding to a 64-bit folder with the given pathname. On a 32-bit computer, this is equivalent to a normal folder Inspector, but on a 64-bit machine, this Inspector returns an object that has filesystem redirection disabled. This action is transitive: any resulting filesystem objects will also have redirection disabled. For example, "pathnames of files of x64 folder <path>" will disable redirection when locating the folder, iterating over the files in the folder and calculating pathnames.Win
application folder <string> of <registry>Returns the folder containing the matching name provided. See application. The application does not have to exist. The folder has to exist.Win, WM
application folder <string> of <registry key>Returns the parent folder associated with the named application. Normally used with a sub-key of key HKEY_CLASSES_ROOT whose name is a file type.Win, WM
application folder of <registry key>Returns the parent folder associated with the named application. Normally used with a sub-key of key HKEY_CLASSES_ROOT whose name is a file type.Win, WM
<registry key value> as folderIf the data stored in the value is a string and it is the full pathname of a folder that exists on disk, the folder object is returned.Win, WM
<filesystem object> as folderReturns a folder or nothing.Mac
ancestor of <filesystem object>Returns all ancestor folders (recursive parent folders) of the given filesystem object (file or folder).Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
parent folder of <filesystem object>The folder containing the specified file or folder.

Example:
posix paths of items whose (name of it starts with "i") of applications folder - Returns a list of the paths of applications starting with "i", such as /Applications/iCal.app, /Applications/iChat.app or /Applications/iTunes.app.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
sibling folder <string> of <filesystem object>A named property. A folder in the same folder as the specified file object.Mac
descendant folder of <folder>Returns the descendant folders, recursively, of the given folder. The folder equivalent of "descendants of <folder>".Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
find folder <string> of <folder>Finds the folder with the given wildcard name inside another folder. A wildcard string uses an asterisk to stand for any number of characters (incuding zero), and a question mark to stand for exactly one character. Thus A??.txt would match All.txt and AXE.txt but not all.txt or a.txt.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
folder <string> of <folder>Returns a folder object for the named sub-folder. Trailing slashes should be omitted from the name.

Example:
exists folder "fonts" of the windows folder - Returns TRUE if fonts is a subdirectory of the Windows directory.

Example:
exists folder "tmp" of root folder - Returns TRUE if tmp is a subdirectory of the root directory.

Example:
exists folder "tmp" of root folder - Returns TRUE if tmp is a subdirectory of the root directory.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
folder ending in <string> of <folder>Returns a list of folders ending in "xxxx". Typically used to identify a dotted extension. Equivalent to a wildcard search for "*xxxx".Mac
folder of <folder>Iterates through the folders of a folder returning folder objects. When combined with a whose clause, you can select folders with specific properties.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
relative folder <string> of <folder>Returns the folder with the path specified by <string> relative to the given <folder>.Mac
relative hfs folder <string> of <folder>Returns the HFS folder with the path specified by <string> relative to the given <folder>.Mac
relative posix folder <string> of <folder>Returns the POSIX folder with the path specified by <string> relative to the given <folder>.Mac
folder <string> of <drive>Returns a folder object corresponding to the name given provided that folder exists on the drive.Win, WM
root folder of <drive>Returns the folder corresponding to the root of the drive.Win, WM
apple extras folder of <domain>Returns the apple extras folder of the specified OS X domain. If the domain is not specified, it defaults to the system domain.Mac
apple menu items folder of <domain>Returns the apple menu items folder of the specified OS X domain. If the domain is not specified, it defaults to the system domain.Mac
application support folder of <domain>Returns the application support folder of the specified OS X domain, typically /Library/Application Support. If the domain is not specified, it defaults to the system domain.Mac
applications folder of <domain>Returns the applications folder of the specified OS X domain, typically /Applications. If the domain is not specified, it defaults to the system domain.Mac
assistants folder of <domain>Returns the assistants folder of the specified OS X domain. If the domain is not specified, it defaults to the system domain.Mac
audio folder of <domain>Returns the audio folder of the specified OS X domain, typically /Library/Audio. If the domain is not specified, it defaults to the system domain.Mac
cache folder of <domain>Returns the cache folder of the specified OS X domain. If the domain is not specified, it defaults to the system domain.Mac
carbon folder of <domain>Returns the carbon folder of the specified OS X domain, typically /Library/Carbon. If the domain is not specified, it defaults to the system domain.Mac
chewable items folder of <domain>Returns the chewable items folder of the specified OS X domain. If the domain is not specified, it defaults to the system domain.Mac
classic folder of <domain>Returns the classic folder of the specified OS X domain, typically the /System Folder. If the domain is not specified, it defaults to the system domain.Mac
color sync folder of <domain>Returns the color sync folder of the specified OS X domain, typically /System/Library/ColorSync. If the domain is not specified, it defaults to the system domain.

Example:
color sync folder of system domain - Returns /System/Library/ColorSync.

Example:
color sync folder of local domain - Returns /Library/ColorSync.
Mac
colorsync profiles folder of <domain>Returns the colorsync profiles folder of the specified OS X domain, typically /System/Library/ColorSync/Profiles. If the domain is not specified, it defaults to the system domain.Mac
component folder of <domain>Returns the component folder of the specified OS X domain, typically /System/Library/Components. If the domain is not specified, it defaults to the system domain.Mac
contextual menu items folder of <domain>Returns the contextual menu items folder of the specified OS X domain, typically /Library/Contextual Menu Items. If the domain is not specified, it defaults to the system domain.Mac
control panels folder of <domain>Returns the control panels folder of the specified OS X domain. If the domain is not specified, it defaults to the system domain.Mac
control strip modules folder of <domain>Returns the control strip modules folder of the specified OS X domain. If the domain is not specified, it defaults to the system domain.Mac
core services folder of <domain>Returns the core services folder of the specified OS X domain, typically /System/Library/CoreServices. If the domain is not specified, it defaults to the system domain.Mac
current user folder of <domain>Returns the current user folder of the specified OS X domain, typically found at /Users/username. If the domain is not specified, it defaults to the system domain.Mac
desktop folder of <domain>Returns the desktop folder of the specified OS X domain, typically /Users/Username/Desktop. If the domain is not specified, it defaults to the system domain.Mac
developer docs folder of <domain>Returns the developer docs folder of the specified OS X domain, typically found at /Developer/Documentation. If the domain is not specified, it defaults to the system domain.Mac
developer folder of <domain>Returns the developer folder of the specified OS X domain, typically found at /Developer. If the domain is not specified, it defaults to the system domain. If the domain is not specified, it defaults to the system domain.Mac
developer help folder of <domain>Returns the help folder of the specified OS X domain, typically /Developer/Documentation/Help. If the domain is not specified, it defaults to the system domain.Mac
disabled control panels folder of <domain>Returns the control panels folder of the specified OS X domain. If the domain is not specified, it defaults to the system domain.Mac
disabled extensions folder of <domain>Returns the extensions folder of the specified OS X domain. If the domain is not specified, it defaults to the system domain.Mac
disabled shutdown items folder of <domain>Returns the shutdown folder of the specified OS X domain. If the domain is not specified, it defaults to the system domain.Mac
disabled startup items folder of <domain>Returns the startup items folder of the specified OS X domain. If the domain is not specified, it defaults to the system domain.Mac
disabled system extensions folder of <domain>Returns the systems extensions folder of the specified OS X domain. If the domain is not specified, it defaults to the system domain.Mac
documentation folder of <domain>Returns the documentation folder for the given OS X domain, typically found at /Library/Documentation. If the domain is not specified, it defaults to the system domain.

Example:
application support folder of user domain - Returns /var/root/Library/Application Support.
Mac
documents folder of <domain>Returns the documents folder for the specified OS X domain, typically found at /User/Username/Documents. If the domain is not specified, it defaults to the system domain.Mac
domain library folder of <domain>Returns the domain library folder of the specified OS X domain, typically found at /Library. If the domain is not specified, it defaults to the system domain.Mac
domain top folder of <domain>Returns the top folder of the specified OS X domain, typically found at /System. If the domain is not specified, it defaults to the system domain.Mac
extensions folder of <domain>Returns the extensions folder of the specified OS X domain. If the domain is not specified, it defaults to the system domain.Mac
favorites folder of <domain>Returns the favorites folder of the specified OS X domain, typically /Users/username/Library/Favorites. If the domain is not specified, it defaults to the system domain.Mac
fonts folder of <domain>Returns the font folder of the specified OS X domain, typically /System/Library/Fonts. If the domain is not specified, it defaults to the system domain.Mac
framework <string> of <domain>Returns a folder of the form "/System/Library/Frameworks/<string>.framework".Note: This Inspector appends .framework for you, so don't provide it. The framework inspector needs a domain, and without it defaults to the system domain.

Example:
framework "MyPrivate" of local domain - Returns /Library/Frameworks/MyPrivate.framework.
Mac
framework folder of <domain>Returns the framework folder of the specified OS X domain, typically /System/Library/Frameworks. If the domain is not specified, it defaults to the system domain.Mac
help folder of <domain>Returns the help folder of the specified OS X domain, typically /Library/Documentation/Help. If the domain is not specified, it defaults to the system domain.Mac
internet plugins folder of <domain>Returns the internet plugins folder of the specified OS X domain. If the domain is not specified, it defaults to the system domain.Mac
iss download folder of <domain>Returns the Macintosh download folder for the specified domain.Mac
kernel extensions folder of <domain>Returns the kernel extensions folder of the specified OS X domain, typically /System/Library/Extensions. If the domain is not specified, it defaults to the system domain.Mac
locales folder of <domain>Returns the locales folder of the specified OS X domain. If the domain is not specified, it defaults to the system domain.Mac
location manager modules folder of <domain>Returns the location manager modules folder of the specified OS X domain. If the domain is not specified, it defaults to the system domain.Mac
location manager preferences folder of <domain>Returns the location manager preferences folder of the specified OS X domain. If the domain is not specified, it defaults to the system domain.Mac
locations folder of <domain>Returns the locations folder of the specified OS X domain. If the domain is not specified, it defaults to the system domain.Mac
macos read me folder of <domain>Returns the Mac OS read me folder of the specified OS X domain. If the domain is not specified, it defaults to the system domain.Mac
modem scripts folder of <domain>Returns the modem scripts folder of the specified OS X domain, typically /System/Library/Modem Scripts. If the domain is not specified, it defaults to the system domain.Mac
preferences folder of <domain>Returns the preferences folder of the specified OS X domain, typically /Users/username/Library/Preferences. If the domain is not specified, it defaults to the system domain.Mac
printer descriptions folder of <domain>Returns the printer descriptions folder of the specified OS X domain, typically /System/Library/Printers/PPDs. If the domain is not specified, it defaults to the system domain.Mac
printer drivers folder of <domain>Returns the printer drivers folder of the specified OS X domain. If the domain is not specified, it defaults to the system domain.Mac
printers folder of <domain>Returns the printers folder of the specified OS X domain, typically /System/Library/Printers. If the domain is not specified, it defaults to the system domain.Mac
printmonitor documents folder of <domain>Returns the printmonitor documents folder of the specified OS X domain, typically /Library/Printers/PrintMonitor Documents. If the domain is not specified, it defaults to the system domain.Mac
private framework folder of <domain>Returns the private framework folder of the specified OS X domain, typically /System/Library/PrivateFrameworks. If the domain is not specified, it defaults to the system domain.Mac
quicktime folder of <domain>Returns the quicktime folder of the specified OS X domain, typically /System/Library/QuickTime. If the domain is not specified, it defaults to the system domain.Mac
receipts folder of <domain>Returns the receipts folder of the specified OS X domain. If the domain is not specified, it defaults to the system domain.Mac
scripting additions folder of <domain>Returns the scripting additions folder of the specified OS X domain, typically /System/Library/Scripting Additions. If the domain is not specified, it defaults to the system domain.Mac
shared folder of <domain>Returns the shared folder of the specified OS X domain, typically /Users/Shared. If the domain is not specified, it defaults to the system domain.Mac
shared libraries folder of <domain>Returns the shared libraries folder of the specified OS X domain, typically /System/Library/CFMSupport. If the domain is not specified, it defaults to the system domain.Mac
shutdown items folder of <domain>Returns the shutdown items folder of the specified OS X domain. If the domain is not specified, it defaults to the system domain.Mac
sound folder of <domain>Returns the sound folder of the specified OS X domain, typically /System/Library/Sound. If the domain is not specified, it defaults to the system domain.Mac
speech folder of <domain>Returns the speech folder of the specified OS X domain, typically /System/Library/Speech. If the domain is not specified, it defaults to the system domain.Mac
startup items folder of <domain>Returns the startup items folder of the specified OS X domain. If the domain is not specified, it defaults to the system domain.Mac
system folder of <domain>Returns the system folder of the specified OS X domain, typically /System. If the domain is not specified, it defaults to the system domain.Mac
temporary items folder of <domain>Returns the temporary items folder of the specified OS X domain, typically /private/tmp/. If the domain is not specified, it defaults to the system domain.Mac
text encodings folder of <domain>Returns the text encodings folder of the specified OS X domain. If the domain is not specified, it defaults to the system domain.Mac
themes folder of <domain>Returns the themes folder of the specified OS X domain. If the domain is not specified, it defaults to the system domain.Mac
user temp folder of <domain>Returns the user temp folder of the specified OS X domain, typically /private/tmp/uid where uid is the user ID number. If the domain is not specified, it defaults to the system domain.Mac
users folder of <domain>Returns the users folder of the specified OS X domain, typically /Users. If the domain is not specified, it defaults to the system domain.Mac
utilities folder of <domain>Returns the utilities folder of the specified OS X domain, typically /Applications/Utilities. If the domain is not specified, it defaults to the system domain.Mac
voices folder of <domain>Returns the voices folder of the specified OS X domain, typically /System/Library/Speech/Voices. If the domain is not specified, it defaults to the system domain.Mac
volume settings folder of <domain>Returns the volume settings folder of the specified OS X domain. If the domain is not specified, it defaults to the system domain.Mac
<symlink> as folderConverts a symlink object into the folder it points to.Lin, Sol, HPUX, AIX, Ubu:8.1
ancestor of <symlink>Returns all ancestor folders (recursive parent folders) of the given symlink.Lin, Sol, HPUX, AIX, Ubu:8.1
parent folder of <symlink>Creates a folder object corresponding to the parent folder of the given symlink.Lin, Sol, HPUX, AIX, Ubu:8.1
client folder of <site>The folder containing the site content on the client machine. Site content is gathered into this location.

Example:
exists file "siteicon.bmp" of client folder of current site - TRUE if the specified file exists in the client folder.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
data folder of <client>Returns the __BESData folderUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
home directory of <user>On a Mac, this Inspector returns the dsAttrTypeStandard:NFSHomeDirectory attribute of the specified user as a folder. Note: On a Windows system, this inspector has a different interpretation: it returns the directory (as a string) where the user files are stored for the specified user.Mac

Properties

DeclarationReturn typeDescriptionPlatforms (?)
system folderfolder

Plural: system folders
Windows systems, returns the 32 bit "System32" folder. eg: C:\Windows\System32 or C:\Windows\SysWow64. Platforms other than Windows this is a synonym for <root folder>Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
apple extras folderfolder

Plural: apple extras folders
Returns the apple extras folder of the system domainMac
apple menu items folderfolder

Plural: apple menu items folders
Returns the apple menu items folder of the system domainMac
application support folderfolder

Plural: application support folders
Returns the application support folder of the system domainMac
applications folderfolder

Plural: applications folders
Returns the applications folder of the system domainMac
assistants folderfolder

Plural: assistants folders
Returns the assistants folder of the system domainMac
audio folderfolder

Plural: audio folders
Returns the audio folder of the system domainMac
cache folderfolder

Plural: cache folders
Returns the cache folder of the system domainMac
carbon folderfolder

Plural: carbon folders
Returns the carbon folder of the system domainMac
chewable items folderfolder

Plural: chewable items folders
Returns the chewable items folder of the system domainMac
classic folderfolder

Plural: classic folders
Returns the classic folder of the system domainMac
color sync folderfolder

Plural: color sync folders
Returns the color sync folder of the system domainMac
colorsync profiles folderfolder

Plural: colorsync profiles folders
Returns the colorsync folder folder of the system domainMac
component folderfolder

Plural: component folders
Returns the component folder of the system domainMac
contextual menu items folderfolder

Plural: contextual menu items folders
Returns the contextual menu items folder of the system domainMac
control panels folderfolder

Plural: control panels folders
Returns the control panels folder of the system domainMac
control strip modules folderfolder

Plural: control strip modules folders
Returns the control strip modules folder of the system domainMac
core services folderfolder

Plural: core services folders
Returns the core services folder of the system domainMac
current user folderfolder

Plural: current user folders
Returns the current user folder of the system domainMac
desktop folderfolder

Plural: desktop folders
Returns the desktop folder of the system domainMac
developer docs folderfolder

Plural: developer docs folders
Returns the developer docs folder of the system domainMac
developer folderfolder

Plural: developer folders
Returns the developer folder of the system domainMac
developer help folderfolder

Plural: developer help folders
Returns the developer help folder of the system domainMac
disabled control panels folderfolder

Plural: disabled control panels folders
Returns the dsiabled control panels folder of the system domainMac
disabled extensions folderfolder

Plural: disabled extensions folders
Returns the disabled extensions folder of the system domainMac
disabled shutdown items folderfolder

Plural: disabled shutdown items folders
Returns the disabled shutdown items folder of the system domainMac
disabled startup items folderfolder

Plural: disabled startup items folders
Returns the disabled startup items folder of the system domainMac
disabled system extensions folderfolder

Plural: disabled system extensions folders
Returns the disabled system extensions folder of the system domainMac
documentation folderfolder

Plural: documentation folders
Returns the documentation folder of the system domainMac
documents folderfolder

Plural: documents folders
Returns the documents folder of the system domainMac
domain library folderfolder

Plural: domain library folders
Returns the domain library folder of the system domainMac
domain top folderfolder

Plural: domain top folders
Returns the domain top folder of the system domainMac
extensions folderfolder

Plural: extensions folders
Returns the extensions folder of the system domainMac
favorites folderfolder

Plural: favorites folders
Returns the favorites folder of the system domainMac
fonts folderfolder

Plural: fonts folders
Returns the fonts folder of the system domainMac
framework folderfolder

Plural: framework folders
Returns the framework folder of the system domainMac
help folderfolder

Plural: help folders
Returns the help folder of the system domainMac
kernel extensions folderfolder

Plural: kernel extensions folders
Returns the kernel extensions folder of the system domainMac
locales folderfolder

Plural: locales folders
Returns the locales folder of the system domainMac
location manager modules folderfolder

Plural: location manager modules folders
Returns the location manager modules folder of the system domainMac
location manager preferences folderfolder

Plural: location manager preferences folders
Returns the location manager preferences folder of the system domainMac
locations folderfolder

Plural: locations folders
Returns the locations folder of the system domainMac
macos read me folderfolder

Plural: macos read me folders
Returns the macos read me folder of the system domainMac
modem scripts folderfolder

Plural: modem scripts folders
Returns the modem scripts folder of the system domainMac
preferences folderfolder

Plural: preferences folders
Returns the preferences folder of the system domainMac
printer descriptions folderfolder

Plural: printer descriptions folders
Returns the preinter descriptions folder of the system domainMac
printer drivers folderfolder

Plural: printer drivers folders
Returns the printer drivers folder of the system domainMac
printers folderfolder

Plural: printers folders
Returns the printers folder of the system domainMac
printmonitor documents folderfolder

Plural: printmonitor documents folders
Returns the printmonitor documents folder of the system domainMac
private framework folderfolder

Plural: private framework folders
Returns the private framework folder of the system domainMac
quicktime folderfolder

Plural: quicktime folders
Returns the quicktime folder of the system domainMac
receipts folderfolder

Plural: receipts folders
Returns the receipts folder of the system domainMac
scripting additions folderfolder

Plural: scripting additions folders
Returns the scripting additions folder of the system domainMac
shared folderfolder

Plural: shared folders
Returns the shared folder of the system domainMac
shared libraries folderfolder

Plural: shared libraries folders
Returns the shared libraries folder of the system domainMac
shutdown items folderfolder

Plural: shutdown items folders
Returns the shutdown items folder of the system domainMac
sound folderfolder

Plural: sound folders
Returns the sound folder of the system domainMac
speech folderfolder

Plural: speech folders
Returns the speech folder of the system domainMac
startup items folderfolder

Plural: startup items folders
Returns the startup items folder of the system domainMac
temporary items folderfolder

Plural: temporary items folders
Returns the temporary items folder of the system domainMac
text encodings folderfolder

Plural: text encodings folders
Returns the text encodings folder of the system domainMac
themes folderfolder

Plural: themes folders
Returns the themes folder of the system domainMac
user temp folderfolder

Plural: user temp folders
Returns the user temp folder of the system domainMac
users folderfolder

Plural: users folders
Returns the users folder of the system domainMac
utilities folderfolder

Plural: utilities folders
Returns the utilities folder of the system domainMac
voices folderfolder

Plural: voices folders
Returns the voices folder of the system domainMac
volume settings folderfolder

Plural: volume settings folders
Returns the volume settings folder of the system domainMac
program files folderfolder

Plural: program files folders
Returns the 32 bit program folder correct for the OS. On 64 bit this is C:\Program Files (x86) and 32 bit it is C:\Program FilesWin:9.0
program files x32 folderfolder

Plural: program files x32 folders
Returns the 32 bit program folder correct for the OS. On 64 bit this is C:\Program Files (x86) and 32 bit it is C:\Program FilesWin:9.0
program files x64 folderfolder

Plural: program files x64 folders
Returns the 64 bit program folder on a 64 bit OS. Returns an error on a 32 bit OS.Win:9.0
application <string> of <folder><application>

Plural: applications
Returns an application object for the named file located in the folder. See application.Win, Lin, Sol, HPUX, AIX, WM, Ubu:8.1
application of <folder><filesystem object>

Plural: applications
Recursively finds executables in the supplied folder, returning a list of "application" objects, which are basically filesystem_objects.Mac
bundle of <folder><bundle>

Plural: bundles
Returns a bundle from a folder (if it has one like application folders do).Mac
bundle version of <folder><version>

Plural: bundle versions
Returns the version of the folder corresponding to the CFBundleVersion string, as distinct from the CFBundleShortVersionString.Mac
descendant folder of <folder><folder>

Plural: descendant folders
Returns the descendant folders, recursively, of the given folder. The folder equivalent of "descendants of <folder>".Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
descendant of <folder><file>

Plural: descendants
Returns a list of all the descendant files of the specified folder.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
device file <string> of <folder><device file>

Plural: device files
Returns the device file with the specified name in the given folder.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
device file of <folder><device file>

Plural: device files
Returns the device files that exist in the specified folder.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
drive of <folder><filesystem>

Plural: drives
Returns the drive associated with the specified folder.On Macintosh computers, this returns a <volume> object.On *nix computers, this returns a <filesystem> object.Lin, Sol, HPUX, AIX, Ubu:8.1
drive of <folder><volume>

Plural: drives
Returns the drive associated with the specified folder.On Macintosh computers, this returns a <volume> object.On *nix computers, this returns a <filesystem> object.Mac
fifo file <string> of <folder><fifo file>

Plural: fifo files
Returns the FIFO file (named pipe) with the given name in the specified folder.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
fifo file of <folder><fifo file>

Plural: fifo files
Returns the list of FIFO file in the given folder.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
file <string> of <folder><file>

Plural: files
Returns a file object for the named file located in the folder.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
file ending in <string> of <folder><file>

Plural: files ending in
Returns a list of files ending in "xxxx". Typically used to identify a dotted extension. Equivalent to a wildcard search for "*xxxx".Mac
file of <folder><file>

Plural: files
Iterates through the files of a folder returning file objects. When combined with a whose clause you can select files with specific properties. See file.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
filesystem of <folder><filesystem>

Plural: filesystems
Returns the filesystem on which the folder resides. On a Macintosh, this Inspector returns a <volume> object.Lin, Sol, HPUX, AIX, Ubu:8.1
filesystem of <folder><volume>

Plural: filesystems
Returns the filesystem on which the folder resides. On a Macintosh, this Inspector returns a <volume> object.Mac
find file <string> of <folder><file>

Plural: find files
Iterates through the files of a folder returning file objects whose name matches the wildcard string provided in the name parameter. A wildcard string uses an asterisk to stand for any number of characters (incuding zero), and a question mark to stand for exactly one character. Thus A??.txt would match All.txt and AXE.txt but not all.txt or a.txt. See example below.Win, Lin, Sol, HPUX, AIX, Mac:8.0, WM, Ubu:8.1
find folder <string> of <folder><folder>

Plural: find folders
Finds the folder with the given wildcard name inside another folder. A wildcard string uses an asterisk to stand for any number of characters (incuding zero), and a question mark to stand for exactly one character. Thus A??.txt would match All.txt and AXE.txt but not all.txt or a.txt.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
find item <string> of <folder><filesystem object>

Plural: find items
Returns the filesystem objects matching the item wildcard string of the given folder. Macintosh 'items' are analogous to files and folders on other systems. A wildcard string uses an asterisk to stand for any number of characters (incuding zero), and a question mark to stand for exactly one character. Thus A??.txt would match All.txt and AXE.txt but not all.txt or a.txt.Mac:8.0
folder <string> of <folder><folder>

Plural: folders
Returns a folder object for the named sub-folder. Trailing slashes should be omitted from the name.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
folder ending in <string> of <folder><folder>

Plural: folders ending in
Returns a list of folders ending in "xxxx". Typically used to identify a dotted extension. Equivalent to a wildcard search for "*xxxx".Mac
folder of <folder><folder>

Plural: folders
Iterates through the folders of a folder returning folder objects. When combined with a whose clause, you can select folders with specific properties.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
hfs relative item <string> of <folder><filesystem object>

Plural: hfs relative items
Returns a filesystem object with the given wildcard name from the specified folder, using HFS format. A wildcard string uses an asterisk to stand for any number of characters (incuding zero), and a question mark to stand for exactly one character. Thus A??.txt would match All.txt and AXE.txt but not all.txt or a.txt.Mac:8.0
item <string> of <folder><filesystem object>

Plural: items
Returns the named item (file or folder) from the specified folder.Mac
item ending in <string> of <folder><filesystem object>

Plural: items ending in
Returns a list of items (files/folders) ending in "xxxx". Typically used to identify a dotted extension. Equivalent to a wildcard search for "*xxxx".Mac
item of <folder><filesystem object>

Plural: items
Returns a list of the items (file or folder) in the specified folder.Mac
posix relative item <string> of <folder><filesystem object>

Plural: posix relative items
Returns a filesystem object with the given relative item name from the specified folder, using POSIX format.Mac:8.0
relative file <string> of <folder><file>

Plural: relative files
Returns the file with the path specified by <string> relative to the given <folder>.Mac
relative folder <string> of <folder><folder>

Plural: relative folders
Returns the folder with the path specified by <string> relative to the given <folder>.Mac
relative hfs file <string> of <folder><file>

Plural: relative hfs files
Returns the HFS file with the path specified by <string> relative to the given <folder>.Mac
relative hfs folder <string> of <folder><folder>

Plural: relative hfs folders
Returns the HFS folder with the path specified by <string> relative to the given <folder>.Mac
relative item <string> of <folder><filesystem object>

Plural: relative items
Returns a filesystem object with the given relative item name from the specified folder, using POSIX format.Mac:8.0
relative posix file <string> of <folder><file>

Plural: relative posix files
Returns the POSIX file with the path specified by <string> relative to the given <folder>.Mac
relative posix folder <string> of <folder><folder>

Plural: relative posix folders
Returns the POSIX folder with the path specified by <string> relative to the given <folder>.Mac
security descriptor of <folder><security descriptor>

Plural: security descriptors
Specifies the security descriptor associated with the specified folder.Win
socket file <string> of <folder><socket file>

Plural: socket files
Returns the socket file with the given name in the specified folder.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
socket file of <folder><socket file>

Plural: socket files
Returns the socket file(s) in the specified folder.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
symlink <string> of <folder><symlink>

Plural: symlinks
Returns the named symlink from the specified folder.Lin, Sol, HPUX, AIX, Ubu:8.1
symlink of <folder><symlink>

Plural: symlinks
Returns the symlink(s) in the specified folder, whether or not they are broken. Note: This behavior differs from looking for files in a folder. Although that returns links along with the files, it doesn't return broken links.Lin, Sol, HPUX, AIX, Ubu:8.1
version of <folder><version>

Plural: versions
Returns a version for a folder representing an application.Mac
volume of <folder><volume>

Plural: volumes
The volume containing the specified folder.Mac

drive

The <drive> object is available to inspect these aspects of the file system.

Creation Methods

DeclarationDescriptionPlatforms (?)
driveIterates through all valid drives on the system. Typically used to return a list of the drives (volumes, filesystems) on the client computer. On Windows computers, this returns a <drive> object.On *nix computers, this returns a <filesystem> object.Drives, volumes and filesystems are treated the same on the Macintosh and return a <volume> type.

Example:
names of drives - Returns a list of drives, eg., C:, D:, etcetera.

Example:
drives - Returns a list of drives, eg., /, /Users/MyUserName, and others.
Win, WM
drive <string>Returns the drive associated with the pathname specified by <string>. On Windows computers, this returns a <drive> object.On Macintosh computers, this returns a <volume> object.On *nix computers, this returns a <filesystem> object.

Example:
file count of drive "/etc/passwd" - Returns the total number of files on the drive containing the specified file.
Win, WM
drive of <filesystem object>Returns the drive associated with the specified file or folder (filesystem object).Win, WM

Properties

DeclarationReturn typeDescriptionPlatforms (?)
volume of <drive><string>

Plural: volumes
Returns the volume name of the drive if presentWin:9.0
file system type of <drive><string>

Plural: file system types
Value as reported by GetVolumeInformation.Win, WM
file_supports_encryption of <drive><boolean>

Plural: file_supports_encryptions
TRUE if bit is returned by GetVolumeInformation.Win, WM
file_supports_object_ids of <drive><boolean>

Plural: file_supports_object_idss
TRUE if bit is returned by GetVolumeInformation.Win, WM
file_supports_reparse_points of <drive><boolean>

Plural: file_supports_reparse_pointss
TRUE if bit is returned by GetVolumeInformation.Win, WM
file_supports_sparse_files of <drive><boolean>

Plural: file_supports_sparse_filess
TRUE if bit is returned by GetVolumeInformation.Win, WM
file_volume_quotas of <drive><boolean>

Plural: file_volume_quotass
TRUE if bit is returned by GetVolumeInformation.Win, WM
folder <string> of <drive><folder>

Plural: folders
Returns a folder object corresponding to the name given provided that folder exists on the drive.Win, WM
free space of <drive><integer>

Plural: free spaces
Returns the number of unused bytes of storage for the drive. (Only available for fixed disks).Win, WM
fs_case_is_preserved of <drive><boolean>

Plural: fs_case_is_preserveds
TRUE if bit is returned by GetVolumeInformation.Win, WM
fs_case_sensitive of <drive><boolean>

Plural: fs_case_sensitives
TRUE if bit is returned by GetVolumeInformation.Win, WM
fs_file_compression of <drive><boolean>

Plural: fs_file_compressions
TRUE if bit is returned by GetVolumeInformation.Win, WM
fs_persistent_acls of <drive><boolean>

Plural: fs_persistent_aclss
TRUE if bit is returned by GetVolumeInformation.Win, WM
fs_unicode_stored_on_disk of <drive><boolean>

Plural: fs_unicode_stored_on_disks
TRUE if bit is returned by GetVolumeInformation.Win, WM
fs_vol_is_compressed of <drive><boolean>

Plural: fs_vol_is_compresseds
TRUE if bit is returned by GetVolumeInformation.Win, WM
name of <drive><string>

Plural: names
Returns the name of the drive. Names look like 'c:' and 'D:'.Win, WM
numeric type of <drive><integer>

Plural: numeric types
Returns the type of drive as an integer.Win, WM
root folder of <drive><folder>

Plural: root folders
Returns the folder corresponding to the root of the drive.Win, WM
total space of <drive><integer>

Plural: total spaces
Returns the size in bytes of the drive. (Only available for fixed disks).Win, WM
type of <drive><string>

Plural: types
Returns the type of drive as a string.Win, WM

bundle

On HPUX platforms, a bundle object is derived from a product type and used to inspect software installations as managed by the Software Depot. On Macintosh platforms, a bundle refers to a core foundation folder hierarchy derived from CFBundle.

Creation Methods

DeclarationDescriptionPlatforms (?)
bundle <string>Returns a bundle (CFBundle) by name.

Example:
bundle "com.apple.BigFixEnterprise" - Returns a bundle to hand to something that needs one. It doesn't print out, per se.
Mac
bundle of <folder>Returns a bundle from a folder (if it has one like application folders do).

Example:
exists (bundle of applications folder) - Typically returns TRUE.
Mac
bundle of <product>Returns the bundle to which the product belongs.HPUX
bundle <string> of <software_depot>Returns the bundle object corresponding to the name provided. Useful for seeing if a bundle is installed.

Example:
exists bundle of folder "iTunes.app" of applications folder - A bundle is a directory in the file system that groups related resources together in one place. Applications, frameworks, and plug-ins are all examples of bundles. Programs can also use document bundles instead of flat files to save complex content. For more info, see the Apple Developer documentation.

Example:
string "CFBundleVersion" of global dictionary of bundle of folder "iTunes.app" of applications folder - Returns the bundle version of the specified folder.
HPUX
bundle of <software_depot>Returns a bundle object. Use the plural expression 'bundles of software depot' to return all of the bundles installed.HPUX

Properties

DeclarationReturn typeDescriptionPlatforms (?)
bundle version of <bundle><version>

Plural: bundle versions
Returns the version of the bundle corresponding to the CFBundleVersion string, as distinct from the CFBundleShortVersionString.Mac
creator of <bundle><file signature>

Plural: creators
The creator 4-letter code of the bundle (for example, FNDR for Finder).Mac
global dictionary of <bundle><dictionary>

Plural: global dictionaries
The bundle's information dictionary.Mac
local dictionary of <bundle><dictionary>

Plural: local dictionaries
The bundle's localized information dictionary.Mac
product of <bundle><product>

Plural: products
Returns the product and/or products contained in the bundle.HPUX
type of <bundle><file type>

Plural: types
Returns the file type of the bundle. Can be used only to compare equality between file types.Mac
version of <bundle><version>

Plural: versions
Version of the given bundle.Mac

volume

The <volume> Inspectors refer to the mounted drive volumes.

Creation Methods

DeclarationDescriptionPlatforms (?)
driveIterates through all valid drives on the system. Typically used to return a list of the drives (volumes, filesystems) on the client computer. On Windows computers, this returns a <drive> object.On *nix computers, this returns a <filesystem> object.Drives, volumes and filesystems are treated the same on the Macintosh and return a <volume> type.

Example:
drives - Returns a list of drives, eg., /, /Users/MyUserName, etcetera.
Mac
drive <integer>Returns the volume corresponding to the numbered drive.Mac
drive <string>Returns the volume corresponding to the named drive.Mac
filesystemReturns the volume corresponding to the filesystem. Typically used to return a list of the filesystems (drives, volumes) on the client computer. Drives, volumes and filesystems are treated the same on the Macintosh and return a <volume> type.

Example:
filesystems - Returns a list of filesystems, eg., /, /Users/MyUserName, etcetera.
Mac
filesystem <integer>Returns the volume corresponding to the numbered filesystem.Mac
filesystem <string>Returns the filesystem corresponding to the specified name. On a Macintosh, this Inspector returns a <volume> object.Mac
volumeAn iterated property. Examines all currently mounted volumes which will include the startup volume, CD-ROM, disk images and other removable media and file sharing volumes.Mac
volume <integer>A numbered property returning the specified volume.Mac
volume <string>A numbered property returning the specified volume.Mac
drive of <file>Returns the drive associated with the specified file.On Macintosh computers, this returns a <volume> object.On *nix computers, this returns a <filesystem> object.

Example:
file count of drive of file "/etc/passwd" - Returns the total number of files on the drive containing passwd.
Mac
filesystem of <file>Returns the UNIX filesystem flag for the given file. On a Macintosh, this returns a <volume> object.

Example:
filesystem of folder "/Users/MyUserName/Library" - Returns /Users/MyUserName.
Mac
volume of <file>The volume containing the file.

Example:
volume of (application "iTunes.app" as folder) is volume of system folder - Returns TRUE if iTunes is installed on the same volume as the system folder.
Mac
drive of <folder>Returns the drive associated with the specified folder.On Macintosh computers, this returns a <volume> object.On *nix computers, this returns a <filesystem> object.

Example:
file count of drive of folder "/export/" - Returns the total number of files on the drive containing the folder export.
Mac
filesystem of <folder>Returns the filesystem on which the folder resides. On a Macintosh, this Inspector returns a <volume> object.Mac
volume of <folder>The volume containing the specified folder.Mac

Operators

DeclarationReturn TypeDescriptionPlatforms (?)
<volume> = <volume><boolean>Compare two volumes.Mac

Properties

DeclarationReturn typeDescriptionPlatforms (?)
allocation block count of <volume><integer>

Plural: allocation block counts
The number of allocation blocks, used or free, on the volume.Mac
directory count of <volume><integer>

Plural: directory counts
The number of directories on the volume.Mac
file count of <volume><integer>

Plural: file counts
The number of files on the volume.Mac
flag of <volume><integer>

Plural: flags
Returns the Mac-specific volume flags.More info on these flags can be found at the Apple developer site, under Carbon > Reference > File Manager.Mac
free percent of <volume><integer>

Plural: free percents
Returns the percentage of room available on the specified volume.Mac
free space of <volume><integer>

Plural: free spaces
The number of free bytes on the volume.Mac
init date of <volume><time>

Plural: init dates
Returns the initialization date of a disk volume.Mac
modification time of <volume><time>

Plural: modification times
Creates a time object corresponding to the time the volume was last modified.Mac
name of <volume><string>

Plural: names
The name of the volume.Mac
size of <volume><integer>

Plural: sizes
Returns a number corresponding to the total number of bytes (used and unused) on the specified volume.Mac
total space of <volume><integer>

Plural: total spaces
The total amount of space, used and free, on the volume.Mac
type of <volume><string>

Plural: types
This Mac Inspector returns the drive type as a string, such as 'DRIVE_FIXED'.Mac:8.1
used percent of <volume><integer>

Plural: used percents
Returns the used percentage of room on the specified volume (or drive or filesystem).Mac
used space of <volume><integer>

Plural: used spaces
Returns a number corresponding to the used bytes on the specified volume.Mac

file shortcut

Shortcuts to files can be constructed in the file system. The shortcut contains some additional properties that can be inspected.

Creation Methods

DeclarationDescriptionPlatforms (?)
shortcut of <file>Returns the properties and locates the target of a file shortcut:pathname (string)start in pathname (string)argument string (string)icon pathname (string)icon index (integer).

Example:
pathname of shortcut of file "BigFix.lnk" of (value "Common Desktop" of key "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Explorer\Shell Folders" of registry as folder) - Returns the pathname associated with the shortcut.
Win

Properties

DeclarationReturn typeDescriptionPlatforms (?)
argument string of <file shortcut><string>

Plural: argument strings
Returns the arguments that are passed to the application to which the shortcut points when the user attempts to open the shortcut.Win
icon index of <file shortcut><integer>

Plural: icon indexes
The index number of the icon in the file containing the icon associated with the shortcut.Win
icon pathname of <file shortcut><string>

Plural: icon pathnames
The full pathname of the file containing the icon associated with the shortcut.Win
pathname of <file shortcut><string>

Plural: pathnames
Returns the full pathname of the object to which the shortcut points.Win
start in pathname of <file shortcut><string>

Plural: start in pathnames
Returns the full pathname the system sets the current directory when the user launches the shortcut.Win

file section

Many programs and utilities store their settings in 'ini' files. This object is designed to access these settings. An 'ini' file is composed of zero or more named sections, each with zero or more keys. Each key is identified by name and has a string value.

Creation Methods

DeclarationDescriptionPlatforms (?)
section <string> of <file>Returns a named section of a file. Useful for locating sections of 'ini' files. Section names are delimited by square bracket characters '[section name]'. See examples below.

Example:
exists Section "General" of file "oeminfo.ini" of system folder - Returns TRUE if a section named "General" appears in the named "ini" file.

Example:
key "Manufacturer" of section "General" of file "oeminfo.ini" of system folder - Returns the name of the computer manufacturer, such as "Dell Computer Corporation".

Example:
key "Manufacturer" of section "General" of file "/etc/oeminfo" - Returns the value of the "Manufacturer" key of the section named "General" of the specified file.

Example:
key "Manufacturer" of section "General" of file "/etc/oeminfo" - Returns the value of the "Manufacturer" key of the section named "General" of the specified file.
Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
key <string> of <file section><string>

Plural: keys
Returns a string containing the value for the name provided. A case-insensitive search is performed through the section of the file.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1

file content

Content objects can be constructed from file objects to inspect their contents.

Creation Methods

DeclarationDescriptionPlatforms (?)
content of <file>Returns an object that can be used to search for a string in the file. See content.

Example:
content of file "oeminfo.ini" of system folder as lowercase contains "dell" - Returns TRUE if the specified file contains the string "dell" anywhere in the file.

Example:
content of file "oeminfo.ini" of system folder as lowercase contains "emachines" - Returns TRUE if either of the strings "emachines" or "eMachines" is found in the file.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<file content> as lowercaseReturns a lowercase version of the content provided.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<file content> as uppercaseReturns an uppercase version of the content provided.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Operators

DeclarationReturn TypeDescriptionPlatforms (?)
<file content> contains <string><boolean>Returns TRUE if the string is located in the content provided.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
<file content> as lowercase<file content>Returns a lowercase version of the content provided.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<file content> as uppercase<file content>Returns an uppercase version of the content provided.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

version

This is the numeric method of indicating the file version, which is compact, convenient and fast. It makes use of a short string to define the version number. Version types are available as both client and core Inspectors, so if you don't find what you want in one guide, please check the other.

Creation Methods

DeclarationDescriptionPlatforms (?)
<string> as versionReturns a version if the string can be parsed as a version. The first numeric set of characters delimited with period, comma or comma-space is returned.Win, WM, Lin, Mac, HPUX, AIX, Sol, Ubu:8.1
quickdraw versionReturns the version of QuickDraw installed.Mac
rom versionReturns the version of the system ROM.

Example:
version of bundle of folder "iTunes.app" of applications folder - Returns the version of the specified folder bundle, such as 4.2.
Mac
system versionReturns the version of MacOS.Mac
version <string>Short hand for 'file version'.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
bundle version of <filesystem object>Returns the version of the filesystem object corresponding to the CFBundleVersion string, as distinct from the CFBundleShortVersionString.Mac
version of <filesystem object>This returns the version information from "vers" resource 1 of the file. It is usually present in applications, and may exist in data files as well. It corresponds to what appears in the "Get Info" box for the specified filesystem object.

Example:
version of primary application "ttxt" is greater than "1.3" - Returns TRUE if the default application for "ttxt" is more recent than version 1.3.
Mac
file version of <file>Returns the file version extracted from the file's resource block. See version.

Example:
file version of application "iexplore.exe" of the registry < "4" - Test for older version of IE -- returns TRUE is version is less than 4.
Win, WM
product version of <file>Returns the product version extracted from the file's resource block. See version.

Example:
product version of file "qna.exe" of parent folder of regapp "bigfix.exe" = product version of regapp "bigfix.exe" - Verifies the existence a co-executable located in the same folder with the proper version.

Example:
product version of regapp "bigfix.exe" > version "1.0.21" - Returns TRUE if the application has a version of 1.0.22 or higher, and FALSE if the application has a version of 1.0.21 or less.

Example:
product version of regapp "bigfix.exe" > version "1.0.21" - Returns TRUE if the application has a version of 1.0.22 or higher, and FALSE if the application has a version of 1.0.21 or less.
Win, WM
raw file version of <file>Returns the file version directly from a PE file.Win, WM
raw product version of <file>Returns the product version directly from a PE file.Win, WM
raw version of <file>Returns the version directly from a PE file.Win, WM
version <integer> of <file>Returns the nth version information from the "vers" resource of the given file. Typically n=1, but other information may be stored in "vers" resources greater than 1.

Example:
version 0 of file "fname" = "1.0" - Checks for the zero version, if one exists.
Mac
version of <file>Synonym for file version of <file>.

Example:
version of file (pathname of shortcut of file "BigFix.lnk" of folder "c:\Documents and Settings\All Users\Desktop") - Returns the version number of the application to which the shortcut points.
Win, Mac, WM
bundle version of <folder>Returns the version of the folder corresponding to the CFBundleVersion string, as distinct from the CFBundleShortVersionString.Mac
version of <folder>Returns a version for a folder representing an application.Mac
bundle version of <bundle>Returns the version of the bundle corresponding to the CFBundleVersion string, as distinct from the CFBundleShortVersionString.Mac
version of <bundle>Version of the given bundle.Mac
<string> as versionReturns a version if the string can be parsed as a version. The first numeric set of characters delimited with period, comma or comma-space is returned.Win, WM, Lin, Mac, HPUX, AIX, Sol, Ubu:8.1
<version> as versionReflexive cast of version.Win, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, WM, Ubu:8.1
maximum of <version>Returns the maximum value from a list of <version> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
minimum of <version>Returns the minimum value from a list of <version> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
pad of <version>Returns a version object which is padded with zero values.

Example:
pad of version "1.2" = version "1.2.0.0" - Returns TRUE.
Win, WM
version of <component>The version of the component, as determined by the component maker.Mac
version of <fileset>Returns the version of the specified fileset.AIX
version of <operating system>Returns the version of the operating system.Win:8.0, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Mac:8.0, Ubu:8.2
version of <service>This Inspector takes the specified service property and retrieves its version (file version).

Example:
version of service "BESClient" - Returns a version number, such as '8.0.584.0'.
Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
version of <scsibus>Version of the SCSI bus.Mac
version of <usb>The version of the USB installed in the system. Taken from the Gestalt Manager.Mac
version of <client>The product version of the BES application (BESClient or QnA).Note: On the Macintosh only, this Inspector returns a <string>.

Example:
version of client as string - Returns a string like "4.0.3.7".
Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
version of <current relay>Returns a version object that is the version of the server that the client last registered with. This may be a BES Relay or the BES root server.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
version of <application usage summary instance>Returns the version of the specified application instance.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
version of <wince_web_browser>Returns the version of the current web browser on the Windows CE device.

Example:
version of default web browser - Returns a version, such as 'iexplore.exe 4.1', corresponding to the current web browser.
WM
version of <package>Returns the version of the given RPM package.Lin, AIX:8.2
bundle version of <bundle>Returns the version of the bundle corresponding to the CFBundleVersion string, as distinct from the CFBundleShortVersionString.Mac
version of <bundle>Version of the given bundle.Mac

Operators

DeclarationReturn TypeDescriptionPlatforms (?)
<version> {cmp} <string><boolean>Returns a boolean TRUE or FALSE, depending on the comparison operator, where:{cmp} is one of: =, !=, <, <=, >, >= .Win, Lin, Sol, HPUX, AIX, Mac, WM
<string> {cmp} <version><boolean>Returns a boolean TRUE or FALSE, depending on the comparison operator, where:{cmp} is one of: =, !=, <, <=, >, >= .Win, Lin, Sol, HPUX, AIX, Mac, WM
<string> {cmp} <version><boolean>Returns a boolean TRUE or FALSE, depending on the comparison operator, where:{cmp} is one of: =, !=, <, <=, >, >= .Win, Lin, Sol, HPUX, AIX, Mac, WM
<version> {cmp} <version><boolean>Returns a boolean TRUE or FALSE, depending on the comparison operator, where:{cmp} is one of: =, !=, <, <=, >, >= .Win, Lin, Sol, HPUX, AIX, Mac, WM

Properties

DeclarationReturn typeDescriptionPlatforms (?)
name registry versionversion

Plural: name registry versions
Returns the version of the Macintosh Name Registry.Mac
stage of <version><stage>

Plural: stages
The stage is represented by the letter in the version string. It may be 'a' for alpha, 'b' for beta, 'd' for development or 'f' for final. If absent, final is implied.Mac:8.1
<string> as version<version>Returns a version if the string can be parsed as a version. The first numeric set of characters delimited with period, comma or comma-space is returned.Win, WM, Lin, Mac, HPUX, AIX, Sol, Ubu:8.1
<version> as string<string>Turns a version type into a string of the form "1.2.3.4".Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<version> as version<version>Reflexive cast of version.Win, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, WM, Ubu:8.1
bug revision of <version><integer>

Plural: bug revisions
If the stage is present the bug revision is the number after the stage. If absent, zero is implied.Mac
build revision of <version><integer>

Plural: build revisions
Returns the final component of a version (Major.Minor.RevisionStageBuild).Mac
extrema of <version><( version, version )>

Plural: extremas
Returns the minimum and maximum extreme values of the given list of <version> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
major revision of <version><integer>

Plural: major revisions
The number before the first period in the version string.Mac
maximum of <version><version>

Plural: maxima
Returns the maximum value from a list of <version> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
minimum of <version><version>

Plural: minima
Returns the minimum value from a list of <version> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
minor revision of <version><integer>

Plural: minor revisions
The number immediately after the first period in the version string. If absent, zero is implied.Mac
pad of <version><version>

Plural: pads
Returns a version object which is padded with zero values.Win, WM
unique value of <version><version with multiplicity>

Plural: unique values
Returns the unique values of a given list of <version> types, removing duplicates and sorting by value.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

version with multiplicity

The <version with multiplicity> Inspectors deal with version arrays, allowing you to extract unique version values and count them.

Creation Methods

DeclarationDescriptionPlatforms (?)
unique value of <version>Returns the unique values of a given list of <version> types, removing duplicates and sorting by value.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
multiplicity of <version with multiplicity><integer>

Plural: multiplicities
Sorts the list and returns the multiplicity, or count, of each unique element in the specified list of multiple <version> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

file version block

You can inspect the version blocks of a file. There may be several language-specific version blocks. Version blocks contain version and name information in a human readable form for the specified language. This is the information that Windows displays in the file properties dialog. This technique uses string values and has a limited array of comparators. For better speed, utility and compactness see the version object.

Creation Methods

DeclarationDescriptionPlatforms (?)
first raw version block of <file>Returns the first version block directly from a PE file. If the first block is sufficient for your purposes, use this version inspector for best speed.Win, WM
only raw version block of <file>Returns the only version block directly from a PE file.Win, WM
only version block of <file>Most files only have 1 version block. This property allows language independent access when there is only one version block present. The result is the same as 'version block 1'.Win, WM
raw version block <integer> of <file>Returns the numbered version block directly from a PE file.Win, WM
raw version block <string> of <file>Returns the named version block directly from a PE file.Win, WM
raw version block of <file>Returns the version block directly from a PE file.Win, WM
version block <integer> of <file>You can identify the particular version block you want to access by ordinal number.

Example:
value "CompanyName" of version block 1 of regapp "bigfix.exe" = "BigFix Inc." - Returns TRUE if the "CompanyName" value of the given file's version block equals the specified string.
Win, WM
version block <string> of <file>You can identify the particular version block you are looking up by name. The name you provide should match the id string of the version block.

Example:
exists version block "040904B0" of regapp "bigfix.exe" - Returns TRUE if the designated version block exists. The case of the name of the version block is ignored.
Win, WM
version block of <file>Iterates through the version blocks of a file.Win, WM

Properties

DeclarationReturn typeDescriptionPlatforms (?)
codepage of <file version block><string>

Plural: codepages
A string representation of the codepage portion of the id of this version block. See notes for known codepage strings. For example, 'Unicode'.Win, WM
id of <file version block><string>

Plural: ids
A string representation containing both the language and codepage of this version block. The format is 8 hex digits, 4 of the codepage concatenated with 4 of the language. For example, '040904b0'. See notes for known values.Win, WM
language of <file version block><string>

Plural: languages
A string representation of the language portion of the id of this version block. For example, 'English (United States)'. See notes for known values.Win, WM
value <string> of <file version block><string>

Plural: values
Returns a string corresponding to the name provided. Values have names such as 'CompanyName', 'FileDescription', 'FileVersion'.Win, WM

strverscmp version

Uses the OS supplied strverscmp function, which may be useful for certain older-style version comparisons. For more information, see the man page for strverscmp.

Creation Methods

DeclarationDescriptionPlatforms (?)
<string> as strverscmp versionConverts a string to strverscmp version, which is compared to other versions using the OS supplied strverscmp function.Ubu:8.1, Lin
strverscmp version <string>Creates a strverscmp version, which is compared to other versions using the OS supplied strverscmp function.Lin, Ubu:8.1

Operators

DeclarationReturn TypeDescriptionPlatforms (?)
<string> {cmp} <strverscmp version><boolean>Returns a boolean TRUE/FALSE depending on the result of the comparison (based on the OS supplied strverscmp function), where:{cmp} is one of: =, !=, <, <=, >, >= .Lin, WM, Ubu:8.1
<strverscmp version> {cmp} <string><boolean>Returns a boolean TRUE/FALSE depending on the result of the comparison (based on the OS supplied strverscmp function), where:{cmp} is one of: =, !=, <, <=, >, >= .Lin, WM, Ubu:8.1
<strverscmp version> {cmp} <strverscmp version><boolean>Returns a boolean TRUE/FALSE depending on the result of the comparison (based on the OS supplied strverscmp function), where:{cmp} is one of: =, !=, <, <=, >, >= .Lin

Properties

DeclarationReturn typeDescriptionPlatforms (?)

domain

Mac OS X defines several file system domains to control access to system resources on multi-user systems. These include the User, Local, Network, Classic and System domains. The domain for a given resource or folder determines its accessibility to the user. For example, while a user-installed font is only available to that user, an administrator-installed font is available to all network users. These Inspectors allow folder access to be parceled out according to domain.Note: The "user domain" refers to the root user, not the currently logged in user.

Creation Methods

DeclarationDescriptionPlatforms (?)
classic domainReturns a classic domain object.Mac
local domainReturns a local domain object.Mac
network domainReturns a network domain object.Mac
on appropriate disk domainReturns one of the Macintosh domains. In most cases, this is the equivalent of kOnAppropriateDisk. On Mac OS X, this constant is used instead of the constant kOnSytemDisk to indicate any disk. For more information, see the Apple documentation on Carbon domain constants.Mac
on system disk domainReturns the OnSystemDisk domain.Mac
system domainReturns a system domain object.Mac
user domainReturns a user domain object.Note: The "user domain" refers to the root user, not the currently logged in user.Mac

Properties

DeclarationReturn typeDescriptionPlatforms (?)
apple extras folder of <domain><folder>

Plural: apple extras folders
Returns the apple extras folder of the specified OS X domain. If the domain is not specified, it defaults to the system domain.Mac
apple menu items folder of <domain><folder>

Plural: apple menu items folders
Returns the apple menu items folder of the specified OS X domain. If the domain is not specified, it defaults to the system domain.Mac
application support folder of <domain><folder>

Plural: application support folders
Returns the application support folder of the specified OS X domain, typically /Library/Application Support. If the domain is not specified, it defaults to the system domain.Mac
applications folder of <domain><folder>

Plural: applications folders
Returns the applications folder of the specified OS X domain, typically /Applications. If the domain is not specified, it defaults to the system domain.Mac
assistants folder of <domain><folder>

Plural: assistants folders
Returns the assistants folder of the specified OS X domain. If the domain is not specified, it defaults to the system domain.Mac
audio folder of <domain><folder>

Plural: audio folders
Returns the audio folder of the specified OS X domain, typically /Library/Audio. If the domain is not specified, it defaults to the system domain.Mac
cache folder of <domain><folder>

Plural: cache folders
Returns the cache folder of the specified OS X domain. If the domain is not specified, it defaults to the system domain.Mac
carbon folder of <domain><folder>

Plural: carbon folders
Returns the carbon folder of the specified OS X domain, typically /Library/Carbon. If the domain is not specified, it defaults to the system domain.Mac
chewable items folder of <domain><folder>

Plural: chewable items folders
Returns the chewable items folder of the specified OS X domain. If the domain is not specified, it defaults to the system domain.Mac
classic folder of <domain><folder>

Plural: classic folders
Returns the classic folder of the specified OS X domain, typically the /System Folder. If the domain is not specified, it defaults to the system domain.Mac
color sync folder of <domain><folder>

Plural: color sync folders
Returns the color sync folder of the specified OS X domain, typically /System/Library/ColorSync. If the domain is not specified, it defaults to the system domain.Mac
colorsync profiles folder of <domain><folder>

Plural: colorsync profiles folders
Returns the colorsync profiles folder of the specified OS X domain, typically /System/Library/ColorSync/Profiles. If the domain is not specified, it defaults to the system domain.Mac
component folder of <domain><folder>

Plural: component folders
Returns the component folder of the specified OS X domain, typically /System/Library/Components. If the domain is not specified, it defaults to the system domain.Mac
contextual menu items folder of <domain><folder>

Plural: contextual menu items folders
Returns the contextual menu items folder of the specified OS X domain, typically /Library/Contextual Menu Items. If the domain is not specified, it defaults to the system domain.Mac
control panels folder of <domain><folder>

Plural: control panels folders
Returns the control panels folder of the specified OS X domain. If the domain is not specified, it defaults to the system domain.Mac
control strip modules folder of <domain><folder>

Plural: control strip modules folders
Returns the control strip modules folder of the specified OS X domain. If the domain is not specified, it defaults to the system domain.Mac
core services folder of <domain><folder>

Plural: core services folders
Returns the core services folder of the specified OS X domain, typically /System/Library/CoreServices. If the domain is not specified, it defaults to the system domain.Mac
current user folder of <domain><folder>

Plural: current user folders
Returns the current user folder of the specified OS X domain, typically found at /Users/username. If the domain is not specified, it defaults to the system domain.Mac
desktop folder of <domain><folder>

Plural: desktop folders
Returns the desktop folder of the specified OS X domain, typically /Users/Username/Desktop. If the domain is not specified, it defaults to the system domain.Mac
developer docs folder of <domain><folder>

Plural: developer docs folders
Returns the developer docs folder of the specified OS X domain, typically found at /Developer/Documentation. If the domain is not specified, it defaults to the system domain.Mac
developer folder of <domain><folder>

Plural: developer folders
Returns the developer folder of the specified OS X domain, typically found at /Developer. If the domain is not specified, it defaults to the system domain. If the domain is not specified, it defaults to the system domain.Mac
developer help folder of <domain><folder>

Plural: developer help folders
Returns the help folder of the specified OS X domain, typically /Developer/Documentation/Help. If the domain is not specified, it defaults to the system domain.Mac
disabled control panels folder of <domain><folder>

Plural: disabled control panels folders
Returns the control panels folder of the specified OS X domain. If the domain is not specified, it defaults to the system domain.Mac
disabled extensions folder of <domain><folder>

Plural: disabled extensions folders
Returns the extensions folder of the specified OS X domain. If the domain is not specified, it defaults to the system domain.Mac
disabled shutdown items folder of <domain><folder>

Plural: disabled shutdown items folders
Returns the shutdown folder of the specified OS X domain. If the domain is not specified, it defaults to the system domain.Mac
disabled startup items folder of <domain><folder>

Plural: disabled startup items folders
Returns the startup items folder of the specified OS X domain. If the domain is not specified, it defaults to the system domain.Mac
disabled system extensions folder of <domain><folder>

Plural: disabled system extensions folders
Returns the systems extensions folder of the specified OS X domain. If the domain is not specified, it defaults to the system domain.Mac
documentation folder of <domain><folder>

Plural: documentation folders
Returns the documentation folder for the given OS X domain, typically found at /Library/Documentation. If the domain is not specified, it defaults to the system domain.Mac
documents folder of <domain><folder>

Plural: documents folders
Returns the documents folder for the specified OS X domain, typically found at /User/Username/Documents. If the domain is not specified, it defaults to the system domain.Mac
domain library folder of <domain><folder>

Plural: domain library folders
Returns the domain library folder of the specified OS X domain, typically found at /Library. If the domain is not specified, it defaults to the system domain.Mac
domain top folder of <domain><folder>

Plural: domain top folders
Returns the top folder of the specified OS X domain, typically found at /System. If the domain is not specified, it defaults to the system domain.Mac
extensions folder of <domain><folder>

Plural: extensions folders
Returns the extensions folder of the specified OS X domain. If the domain is not specified, it defaults to the system domain.Mac
favorites folder of <domain><folder>

Plural: favorites folders
Returns the favorites folder of the specified OS X domain, typically /Users/username/Library/Favorites. If the domain is not specified, it defaults to the system domain.Mac
fonts folder of <domain><folder>

Plural: fonts folders
Returns the font folder of the specified OS X domain, typically /System/Library/Fonts. If the domain is not specified, it defaults to the system domain.Mac
framework <string> of <domain><folder>

Plural: frameworks
Returns a folder of the form "/System/Library/Frameworks/<string>.framework".Note: This Inspector appends .framework for you, so don't provide it. The framework inspector needs a domain, and without it defaults to the system domain.Mac
framework folder of <domain><folder>

Plural: framework folders
Returns the framework folder of the specified OS X domain, typically /System/Library/Frameworks. If the domain is not specified, it defaults to the system domain.Mac
help folder of <domain><folder>

Plural: help folders
Returns the help folder of the specified OS X domain, typically /Library/Documentation/Help. If the domain is not specified, it defaults to the system domain.Mac
internet plugins folder of <domain><folder>

Plural: internet plugins folders
Returns the internet plugins folder of the specified OS X domain. If the domain is not specified, it defaults to the system domain.Mac
iss download folder of <domain><folder>

Plural: iss download folders
Returns the Macintosh download folder for the specified domain.Mac
kernel extensions folder of <domain><folder>

Plural: kernel extensions folders
Returns the kernel extensions folder of the specified OS X domain, typically /System/Library/Extensions. If the domain is not specified, it defaults to the system domain.Mac
locales folder of <domain><folder>

Plural: locales folders
Returns the locales folder of the specified OS X domain. If the domain is not specified, it defaults to the system domain.Mac
location manager modules folder of <domain><folder>

Plural: location manager modules folders
Returns the location manager modules folder of the specified OS X domain. If the domain is not specified, it defaults to the system domain.Mac
location manager preferences folder of <domain><folder>

Plural: location manager preferences folders
Returns the location manager preferences folder of the specified OS X domain. If the domain is not specified, it defaults to the system domain.Mac
locations folder of <domain><folder>

Plural: locations folders
Returns the locations folder of the specified OS X domain. If the domain is not specified, it defaults to the system domain.Mac
macos read me folder of <domain><folder>

Plural: macos read me folders
Returns the Mac OS read me folder of the specified OS X domain. If the domain is not specified, it defaults to the system domain.Mac
modem scripts folder of <domain><folder>

Plural: modem scripts folders
Returns the modem scripts folder of the specified OS X domain, typically /System/Library/Modem Scripts. If the domain is not specified, it defaults to the system domain.Mac
preferences folder of <domain><folder>

Plural: preferences folders
Returns the preferences folder of the specified OS X domain, typically /Users/username/Library/Preferences. If the domain is not specified, it defaults to the system domain.Mac
printer descriptions folder of <domain><folder>

Plural: printer descriptions folders
Returns the printer descriptions folder of the specified OS X domain, typically /System/Library/Printers/PPDs. If the domain is not specified, it defaults to the system domain.Mac
printer drivers folder of <domain><folder>

Plural: printer drivers folders
Returns the printer drivers folder of the specified OS X domain. If the domain is not specified, it defaults to the system domain.Mac
printers folder of <domain><folder>

Plural: printers folders
Returns the printers folder of the specified OS X domain, typically /System/Library/Printers. If the domain is not specified, it defaults to the system domain.Mac
printmonitor documents folder of <domain><folder>

Plural: printmonitor documents folders
Returns the printmonitor documents folder of the specified OS X domain, typically /Library/Printers/PrintMonitor Documents. If the domain is not specified, it defaults to the system domain.Mac
private framework folder of <domain><folder>

Plural: private framework folders
Returns the private framework folder of the specified OS X domain, typically /System/Library/PrivateFrameworks. If the domain is not specified, it defaults to the system domain.Mac
quicktime folder of <domain><folder>

Plural: quicktime folders
Returns the quicktime folder of the specified OS X domain, typically /System/Library/QuickTime. If the domain is not specified, it defaults to the system domain.Mac
receipts folder of <domain><folder>

Plural: receipts folders
Returns the receipts folder of the specified OS X domain. If the domain is not specified, it defaults to the system domain.Mac
scripting additions folder of <domain><folder>

Plural: scripting additions folders
Returns the scripting additions folder of the specified OS X domain, typically /System/Library/Scripting Additions. If the domain is not specified, it defaults to the system domain.Mac
shared folder of <domain><folder>

Plural: shared folders
Returns the shared folder of the specified OS X domain, typically /Users/Shared. If the domain is not specified, it defaults to the system domain.Mac
shared libraries folder of <domain><folder>

Plural: shared libraries folders
Returns the shared libraries folder of the specified OS X domain, typically /System/Library/CFMSupport. If the domain is not specified, it defaults to the system domain.Mac
shutdown items folder of <domain><folder>

Plural: shutdown items folders
Returns the shutdown items folder of the specified OS X domain. If the domain is not specified, it defaults to the system domain.Mac
sound folder of <domain><folder>

Plural: sound folders
Returns the sound folder of the specified OS X domain, typically /System/Library/Sound. If the domain is not specified, it defaults to the system domain.Mac
speech folder of <domain><folder>

Plural: speech folders
Returns the speech folder of the specified OS X domain, typically /System/Library/Speech. If the domain is not specified, it defaults to the system domain.Mac
startup items folder of <domain><folder>

Plural: startup items folders
Returns the startup items folder of the specified OS X domain. If the domain is not specified, it defaults to the system domain.Mac
system folder of <domain><folder>

Plural: system folders
Returns the system folder of the specified OS X domain, typically /System. If the domain is not specified, it defaults to the system domain.Mac
temporary items folder of <domain><folder>

Plural: temporary items folders
Returns the temporary items folder of the specified OS X domain, typically /private/tmp/. If the domain is not specified, it defaults to the system domain.Mac
text encodings folder of <domain><folder>

Plural: text encodings folders
Returns the text encodings folder of the specified OS X domain. If the domain is not specified, it defaults to the system domain.Mac
themes folder of <domain><folder>

Plural: themes folders
Returns the themes folder of the specified OS X domain. If the domain is not specified, it defaults to the system domain.Mac
user temp folder of <domain><folder>

Plural: user temp folders
Returns the user temp folder of the specified OS X domain, typically /private/tmp/uid where uid is the user ID number. If the domain is not specified, it defaults to the system domain.Mac
users folder of <domain><folder>

Plural: users folders
Returns the users folder of the specified OS X domain, typically /Users. If the domain is not specified, it defaults to the system domain.Mac
utilities folder of <domain><folder>

Plural: utilities folders
Returns the utilities folder of the specified OS X domain, typically /Applications/Utilities. If the domain is not specified, it defaults to the system domain.Mac
voices folder of <domain><folder>

Plural: voices folders
Returns the voices folder of the specified OS X domain, typically /System/Library/Speech/Voices. If the domain is not specified, it defaults to the system domain.Mac
volume settings folder of <domain><folder>

Plural: volume settings folders
Returns the volume settings folder of the specified OS X domain. If the domain is not specified, it defaults to the system domain.Mac

mode

The <mode> inpector returns file type information and permissions. These are the possible values of mode:S_IFMT 170000 bitmask for the file type bitfieldsS_IFSOCK 140000 socketS_IFLNK 120000 symbolic linkS_IFREG 100000 regular fileS_IFBLK 060000 block deviceS_IFDIR 040000 directoryS_IFCHR 020000 character deviceS_IFIFO 010000 fifoS_ISUID 004000 set UID bitS_ISGID 002000 set GID bitS_ISVTX 001000 sticky bitS_IRWXU 000700 mask for file owner permissionsS_IRUSR 000400 owner has read permissionS_IWUSR 000200 owner has write permissionS_IXUSR 000100 owner has execute permissionS_IRWXG 000070 mask for group permissionsS_IRGRP 000040 group has read permissionS_IWGRP 000020 group has write permissionS_IXGRP 000010 group has execute permissionS_IRWXO 000007 mask for permissions for others (not in group)S_IROTH 000004 others have read permissionS_IWOTH 000002 others have write permissionS_IXOTH 000001 others have execute permission

Creation Methods

DeclarationDescriptionPlatforms (?)
mode of <filesystem object>Returns the permissions mode for the given filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
<mode> as octal string<string>Converts the mode to a string of octal numbers.Lin, Sol, HPUX, AIX, Ubu:8.1
<mode> as string<string>Converts the mode to a string.Lin, Sol, HPUX, AIX, Ubu:8.1
group mask of <mode><mode_mask>

Plural: group masks
Returns the mask for group permissions for the given mode.Lin, Sol, HPUX, AIX, Ubu:8.1
other mask of <mode><mode_mask>

Plural: other masks
Returns the mask for permissions for others (those not in the group) for the given mode.Lin, Sol, HPUX, AIX, Ubu:8.1
setgid of <mode><boolean>

Plural: setgids
Returns TRUE if setgid (the group ID flag) is set.Lin, Sol, HPUX, AIX, Ubu:8.1
setuid of <mode><boolean>

Plural: setuids
Returns TRUE if setuid (the user ID flag) is set.Lin, Sol, HPUX, AIX, Ubu:8.1
sticky of <mode><boolean>

Plural: stickies
The `sticky' bit (S_ISVTX) on a directory means that a file in that directory can be renamed or deleted only by the owner of the file, by the owner of the directory, and by root. This inspector returns TRUE if the sticky bit of the given mode is on.Lin, Sol, HPUX, AIX, Ubu:8.1
user mask of <mode><mode_mask>

Plural: user masks
Returns the mask for the user (file owner) permissions for the given mode.Lin, Sol, HPUX, AIX, Ubu:8.1

mode_mask

The <mode_mask> Inspector is a differently formatted version of the mode, created by shifting the key information down to the low three bits.

Creation Methods

DeclarationDescriptionPlatforms (?)
group mask of <mode>Returns the mask for group permissions for the given mode.Lin, Sol, HPUX, AIX, Ubu:8.1
other mask of <mode>Returns the mask for permissions for others (those not in the group) for the given mode.Lin, Sol, HPUX, AIX, Ubu:8.1
user mask of <mode>Returns the mask for the user (file owner) permissions for the given mode.Lin, Sol, HPUX, AIX, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
<mode_mask> as integer<integer>Converts the mode mask to an integer, 1-4.Lin, Sol, HPUX, AIX, Ubu:8.1
<mode_mask> as string<string>Converts the mode mask to a string, for example "rwx".Lin, Sol, HPUX, AIX, Ubu:8.1
execute of <mode_mask><boolean>

Plural: executes
Returns TRUE if the execute flag (x) of the rwx mode mask is on. (binary 001 = 1).Lin, Sol, HPUX, AIX, Ubu:8.1
read of <mode_mask><boolean>

Plural: reads
Returns TRUE if the read flag of the rwx mode mask is on. (binary 100 = 4).Lin, Sol, HPUX, AIX, Ubu:8.1
write of <mode_mask><boolean>

Plural: writes
Returns TRUE if the write flag (w) of the rwx mode mask is on. (binary 010 = 2).Lin, Sol, HPUX, AIX, Ubu:8.1

file type

The <file type> Inspectors provide access to the four character file type associated with some types of files.

Creation Methods

DeclarationDescriptionPlatforms (?)
file type <string>The phrase 'file type' can be used to create a file type object from a string.

Example:
creator of "that file" of "that folder" is file type "ttxt" - Returns TRUE if "that file" is a TeachText file.
Mac
type of <file>This refers to the four-character identifier used in all MacOS files. The type describes the sort of file it is.

Example:
type of 'that file' of folder 'that folder' is file type 'TEXT' - Checks to see if the given file is a text file type
Mac
type of <bundle>Returns the file type of the bundle. Can be used only to compare equality between file types.

Example:
type of bundle of applications folder = type of bundle of domain library folder - Returns TRUE if the specified types are the same.
Mac
type of <bundle>Returns the file type of the bundle. Can be used only to compare equality between file types.

Example:
type of bundle of applications folder = type of bundle of domain library folder - Returns TRUE if the specified types are the same.
Mac

Operators

DeclarationReturn TypeDescriptionPlatforms (?)
<file type> = <file type><boolean>Compare two file types.Mac

Properties

DeclarationReturn typeDescriptionPlatforms (?)

file signature

The <file signature> Inspectors provide access to each of the four character file signatures associated with some types of files.

Creation Methods

DeclarationDescriptionPlatforms (?)
file signature <string>Turn a string into a file signature (four letters, for example FNDR).Mac
creator of <file>This refers to the four-character identifier used in all MacOS files. The creator tells what application should open the specified file.Mac
creator of <bundle>The creator 4-letter code of the bundle (for example, FNDR for Finder).

Example:
creator of bundle of applications folder = creator of bundle of preferences folder - Returns TRUE if the creator of the application and preference folders are the same.
Mac
creator of <bundle>The creator 4-letter code of the bundle (for example, FNDR for Finder).

Example:
creator of bundle of applications folder = creator of bundle of preferences folder - Returns TRUE if the creator of the application and preference folders are the same.
Mac

Operators

DeclarationReturn TypeDescriptionPlatforms (?)
<file signature> = <file signature><boolean>Compares two Macintosh file signatures.Mac

Properties

DeclarationReturn typeDescriptionPlatforms (?)

component

Components are handled by the MacOS Component Manager. These Inspectors provide access to the various software components available through the Component Manager. The information contained in a component is placed there by its maker. How it should be interpreted is also determined by the maker.

Creation Methods

DeclarationDescriptionPlatforms (?)
componentIs an iterated property. The MacOS supports software "components", for example QuickTime codecs. This iterator can examine the components that are available.Mac

Properties

DeclarationReturn typeDescriptionPlatforms (?)
info of <component><string>

Plural: infos
Returns information about the component, as determined by the creator of the component.Mac
maker of <component><string>

Plural: makers
Returns the name of the maker of the specified component.Mac
name of <component><string>

Plural: names
The name of the component, as determined by its maker.Mac
subtype of <component><string>

Plural: subtypes
The subtype of the component, as determined by the component maker.Mac
type of <component><string>

Plural: types
The type of the component, as determined by the component maker.Mac
version of <component><version>

Plural: versions
The version of the component, as determined by the component maker.Mac

datafork

The <datafork> Inspectors refer to the data fork of a filesystem object.

Creation Methods

DeclarationDescriptionPlatforms (?)
data fork of <file>Returns information about the data fork of the specified file.Mac

Properties

DeclarationReturn typeDescriptionPlatforms (?)
length of <datafork><integer>

Plural: lengths
The logical length of the data fork of the file.Mac
size of <datafork><integer>

Plural: sizes
Returns the size of the specified datafork.Mac

resfork

The <resfork> Inspectors refer to the resource fork of a filesystem object.

Creation Methods

DeclarationDescriptionPlatforms (?)
resource fork of <file>Returns information about the resource fork of the file.Mac

Properties

DeclarationReturn typeDescriptionPlatforms (?)
length of <resfork><integer>

Plural: lengths
The logical length of the resource fork of the file.Mac
size of <resfork><integer>

Plural: sizes
Returns the size of the resource fork.Mac

dictionaryentry

The <dictionaryentry> inspectors provide access to the entries of a dictionary.

Creation Methods

DeclarationDescriptionPlatforms (?)
entry of <dictionary>A key-value pair of a dictionary.

Example:
keys of entries of dictionary of iokit registry - Returns the specified keys, for example: IOKitBuildVersion, IONDRVFrameBufferGeneration, IOConsoleUsers, IOKitDiagnostics, IORegistryPlanes, IOMaximumMappedIOByteCount, IOCatalogue.
Mac

Properties

DeclarationReturn typeDescriptionPlatforms (?)
key of <dictionaryentry><string>

Plural: keys
The key of the given dictionary entry.Mac:8.1
value of <dictionaryentry><osxvalue>

Plural: values
Values of the dictionary entry.Mac:8.1

dictionary

The <dictionary> Inspectors provide access to an XML dictionary as used in .plist (property list) files.

Creation Methods

DeclarationDescriptionPlatforms (?)
dictionary <integer> of <array>Get, from an array, a dictionary keyed by the specified integer.

Example:
exists dictionary 0 of array "LogFileDicts" of preference "com.apple.Console" - See the Apple Developer documentation.
Mac
dictionary of <file>Returns the dictionary object for the specified file.

Example:
exists dictionary of file "com.apple.scheduler.plist" of preferences folder - Returns TRUE if the specified dictionary exists.
Mac
global dictionary of <bundle>The bundle's information dictionary.

Example:
string "CFBundleVersion" of global dictionary of bundle of folder "iTunes.app" of applications folder - Returns the specified bundle version.
Mac
local dictionary of <bundle>The bundle's localized information dictionary.

Example:
keys of entries of local dictionary of bundle of folder "iTunes.app" of applications folder - Returns information in the default system langauge for bundles that include localized resources, such as Movie File, iTunes Remote Library URL, MP2 Audio File, WAVE Audio File, MP3 Audio File, CFBundleHelpBookName, Equalizer Settings, Tunes Database File, and more...
Mac
dictionary <string> of <dictionary>Get, from a dictionary, a dictionary keyed by the specified string.

Example:
exists dictionary "Timer" of dictionary "SUCheckSchedulerTag" of dictionary "com.apple.SoftwareUpdate" of dictionary "AbsoluteSchedule" of dictionary of file "com.apple.scheduler.plist" of preferences folder - Returns TRUE if the specified dictionary exists.
Mac
dictionary of <osxvalue>Casts the osxvalue (essentially untyped) to a dictionary.Mac
dictionary <string> of <preference>Get, from a preference, a dictionary keyed by the specified string.

Example:
exists dictionary "Timer" of dictionary "SUCheckSchedulerTag" of dictionary "com.apple.SoftwareUpdate" of dictionary "AbsoluteSchedule" of preference "com.apple.scheduler" - Returns TRUE if the specified dictionary exists.
Mac
dictionary of <registryroot>Returns a dictionary from the root of the IOKit registry.

Example:
keys of entries of dictionary of iokit registry - Returns the specified keys, for example: IOKitBuildVersion, IONDRVFrameBufferGeneration, IOConsoleUsers, IOKitDiagnostics, IORegistryPlanes, IOMaximumMappedIOByteCount, IOCatalogue.
Mac
dictionary of <registrynode>Returns a dictionary from a node in the IORegistry.

Example:
keys of entries of dictionary of usb plane of iokit registry - Returns the specified keys, for example: Device Speed, iSerialNumber, bNumConfigurations, IOUserClientClass, AAPL, current-available, bDeviceClass, USB Product Name, IOCFPlugInTypes.
Mac
global dictionary of <bundle>The bundle's information dictionary.

Example:
string "CFBundleVersion" of global dictionary of bundle of folder "iTunes.app" of applications folder - Returns the specified bundle version.
Mac
local dictionary of <bundle>The bundle's localized information dictionary.

Example:
keys of entries of local dictionary of bundle of folder "iTunes.app" of applications folder - Returns information in the default system langauge for bundles that include localized resources, such as Movie File, iTunes Remote Library URL, MP2 Audio File, WAVE Audio File, MP3 Audio File, CFBundleHelpBookName, Equalizer Settings, Tunes Database File, and more...
Mac

Properties

DeclarationReturn typeDescriptionPlatforms (?)
array <string> of <dictionary><array>

Plural: arrays
Get, from a dictionary, an array keyed by the specified string.Mac
boolean <string> of <dictionary><boolean>

Plural: booleans
Get, from a dictionary, a boolean keyed by the string.Mac
cstring <string> of <dictionary><string>

Plural: cstrings
Get, from a dictionary, the string keyed by the specified string. Works for objects in a dictionary of type String or Data. If the type is Data, any null terminator will be stripped.Mac
data <string> of <dictionary><string>

Plural: datas
Returns the specified dictionary data as a string.Mac
date <string> of <dictionary><time>

Plural: dates
Get, from a dictionary, a date keyed by the specified string.Mac
dictionary <string> of <dictionary><dictionary>

Plural: dictionaries
Get, from a dictionary, a dictionary keyed by the specified string.Mac
entry of <dictionary><dictionaryentry>

Plural: entries
A key-value pair of a dictionary.Mac
integer <string> of <dictionary><integer>

Plural: integers
Get, from a dictionary, an integer keyed by the specified string.Mac
key of <dictionary><string>

Plural: keys
The keys of a dictionary.Mac
size of <dictionary><integer>

Plural: sizes
The size of the given dictionary.Mac
string <string> of <dictionary><string>

Plural: strings
Get, from a dictionary, the string keyed by the specified string. Works for objects in a dictionary of type String or Data. If the type is Data, any null terminator will be returned as part of the string. Use cstring if you expect a Data object containing a null terminated string.Mac

country

The <country> Inspectors allow comparing countries (as seen in version numbers).

Creation Methods

DeclarationDescriptionPlatforms (?)
country <string>Maps a country script string (for example verAfrikaans) to its region code.

Example:
exists (country "verChina") - Returns TRUE if there exists a Chinese script string.
Mac

Operators

DeclarationReturn TypeDescriptionPlatforms (?)
<country> = <country><boolean>Compares two countries, as found in a Macintosh version.Mac

Properties

DeclarationReturn typeDescriptionPlatforms (?)

osxvalue

The <osxvalue> Inspectors provide access to the elements of a dictionary.

Creation Methods

DeclarationDescriptionPlatforms (?)
value of <array>Values of the array.

Example:
strings of values of array "RecentSearchStrings" of preference "com.apple.safari" - Returns a list of the most recent search strings, in temporal order.
Mac
value of <dictionaryentry>Values of the dictionary entry.Mac:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
array of <osxvalue><array>

Plural: arrays
Casts the osxvalue (which is essentially untyped) to an array.Mac
boolean of <osxvalue><boolean>

Plural: booleans
Casts the osxvalue (which is essentially untyped) to a boolean.Mac
cstring of <osxvalue><string>

Plural: cstrings
Strips off any trailing null from an osxvalue, returning a proper string from the dictionary.Note: In Version 6.0.9.54, the plural inspector is misspelled as csrings.Mac
data of <osxvalue><string>

Plural: datas
Casts the specified osxvalue to a string.Mac
date of <osxvalue><time>

Plural: dates
Casts the osxvalue (essentially untyped) to a date.Mac
dictionary of <osxvalue><dictionary>

Plural: dictionaries
Casts the osxvalue (essentially untyped) to a dictionary.Mac
integer of <osxvalue><integer>

Plural: integers
Casts the osxvalue (essentially untyped) to an integer.Mac
string of <osxvalue><string>

Plural: strings
The string of the osxvalue, cast to a string if necessary.Mac
type of <osxvalue><string>

Plural: types
The type of the osxvalue (for example boolean, string, integer, data, date, array, dictionary, or unknown type).Mac

preference

The <preference> Inspectors provide access to application preference files.

Creation Methods

DeclarationDescriptionPlatforms (?)
preference <string>The named set of preferences.

Example:
boolean "autohide" of preference "com.apple.dock" - Returns TRUE if the autohide preference is set.
Mac

Properties

DeclarationReturn typeDescriptionPlatforms (?)
array <string> of <preference><array>

Plural: arrays
Get, from a preference file, an array keyed by the specified string.Mac
boolean <string> of <preference><boolean>

Plural: booleans
Get, from a preference file, a boolean keyed by the specified string.Mac
date <string> of <preference><time>

Plural: dates
Get, from a preference, a date keyed by the specified string.Mac
dictionary <string> of <preference><dictionary>

Plural: dictionaries
Get, from a preference, a dictionary keyed by the specified string.Mac
integer <string> of <preference><integer>

Plural: integers
Get, from a preference, an integer keyed by the specified string.Mac
string <string> of <preference><string>

Plural: strings
Get, from a preference, the string keyed by the specified string.Mac

stage

The <stage> objects are for inspecting the stage portion of version numbers, which is the penultimate section of a version string: Major.Minor.ReleaseStageBuild.

Creation Methods

DeclarationDescriptionPlatforms (?)
stage of <version>The stage is represented by the letter in the version string. It may be 'a' for alpha, 'b' for beta, 'd' for development or 'f' for final. If absent, final is implied.Mac:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
<stage> as string<string>A Macintosh version is of the form: Major.Minor.ReleaseStageBuild. The stage directly precedes the final (Build) number. Most versioning schemes use a period, but the Mac allows for d, a, b and f standing for Development , Alpha, Beta and Final. The period has a higher value than Final. The stage is used in version comparisons and is ranked higher than the build number. For instance, 7.1.2a43 is less than 7.1.2f42 because a is lower than f, even though the final number is bigger.Mac

fileset

The <fileset> objects represent the set of files required for installing a software package.

Creation Methods

DeclarationDescriptionPlatforms (?)
latest installed fileset of <fileset version requirement>Returns the filesets that are installed with the same LPP name, regardless of version.AIX:8.2
satisfying fileset of <fileset version requirement>Returns the filesets that are installed with the same LPP name and a greater or equal version.AIX:8.2
fileset of <product>Returns a list of the filesets (installable software packages) in the specified product.

Example:
filesets of products "bos.terminfo" of object repository - Returns a list of the various versions of the specified program from the object repository.
AIX
fileset <string> of <object repository>Returns all filesets exactly matching the string in the format "lpp_name ver.rel.mod.fix".AIX:8.2
fileset matching <string> of <object repository>Returns all filesets matching the supplied ODM query string.AIX:8.2
fileset of <object repository>Returns all filesets. This may include multiple versions with the same LPP name.AIX:8.2
fileset with name <string> of <object repository>Returns all filesets whose LPP name exactly matches the string.AIX:8.2
latest fileset <string> of <object repository>Returns the fileset whose LPP name exactly matches the string and has the highest version record.AIX:8.2
fileset matching <string> of <object_repository>Returns the fileset(s) matching the specified string from within the object repository.

Example:
filesets matching "description = 'Inventory Scout Runtime'" of object repository - Returns the filesets matching the given string, in this case the description.
AIX

Properties

DeclarationReturn typeDescriptionPlatforms (?)
<fileset> as string<string>Casts a fileset as a string type.AIX
description of <fileset><string>

Plural: descriptions
Returns a description of a set of installation files.AIX
lpp_name of <fileset><string>

Plural: lpp_names
Licensed Program Product(s) of the fileset.AIX
product of <fileset><product>

Plural: products
Returns the product corresponding to the specified fileset.AIX
root part of <fileset><fileset part>

Plural: root parts
Returns the machine-specific portions of the specified fileset (the root part), which contains the part of the product that cannot be shared among machines -- each client must have its own copy. For a standard system, files in the root part are stored in the root (/) file tree. AIX:8.2
share part of <fileset><fileset part>

Plural: share parts
Returns the share part of the specified fileset.AIX:8.2
update of <fileset><integer>

Plural: updates
Returns the update number for the specified fileset.AIX
usr part of <fileset><fileset part>

Plural: usr parts
Returns the machine-shareable portions of the specified fileset (the usr part), which contains the part of the product that can be shared among several machines with compatible hardware architectures. The usr part of the fileset contains files that reside in the /usr or /opt file system.AIX:8.2
version of <fileset><version>

Plural: versions
Returns the version of the specified fileset.AIX
version record of <fileset><fileset version record>

Plural: version records
Returns the version record corresponding to the specified fileset as a fileset version record.AIX:8.2

file line

A <file line> object produces strings from a text file.

Creation Methods

DeclarationDescriptionPlatforms (?)
line <integer> of <file>Returns the nth line (specified by <integer>) from the given file.

Example:
line 2 of (file "printmon.inf" of system folder) - Returns the second line of the specified file.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
line containing <string> of <file>Returns all lines from the given file that contain the specified string.

Example:
lines containing "Signature]" of file "mmdriver.inf" of system folder - Returns a list corresponding to the top-level sections involving signatures in the specified .inf file.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
line of <file>Iterates over all the lines of the specified file. Note that the lines are truncated to 1023 characters.

Example:
lines of file "c:\autoexec.bat" - Returns all the lines in the specified autoexec.bat file.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
line starting with <string> of <file>Same as line <string> of <file>, returns the lines of the given file that start with the specified string.

Example:
lines starting with "[" of file "mmdriver.inf" of system folder - Returns a list corresponding to all the top-level sections (lines that start with "[") in the specified .inf file.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
next line of <file line>Returns the line after the specified line in a file (provided that it is not the last line). This Inspector can be chained indefinitely, eg., next line of next line of ...

Example:
next line of line containing "[mciavi]" of file "mmdriver.inf" of system folder - Returns the line after the one containing "[mciavi]", which is a string such as "1:MSVFW32.DLL".
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
previous line of <file line>Returns the line before the nth line in a file, provided n>1. You may repeat this command up to three times.

Example:
previous line of previous line of previous line of line containing "[mciavi]" of file "mmdriver.inf" of system folder - Returns the line 3 lines previous to the one containing the specified phrase in the given file.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
line number of <file line><integer>

Plural: line numbers
Returns the line number of a given line. Can be used to locate specific lines in a file.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
next line of <file line><file line>

Plural: next lines
Returns the line after the specified line in a file (provided that it is not the last line). This Inspector can be chained indefinitely, eg., next line of next line of ...Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
previous line of <file line><file line>

Plural: previous lines
Returns the line before the nth line in a file, provided n>1. You may repeat this command up to three times.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

xml dom node

The <xml dom node> objects are the Inspectors for the XML Document Object Module (DOM) nodes. The console uses MSXML 6.0 if it is available. Otherwise it falls back to 4.0. The console requires at least 4.0 since 3.0 does not provide XML schema validation.

Creation Methods

DeclarationDescriptionPlatforms (?)
attribute <integer> of <xml dom node>Returns the numbered attribute of the specified XML DOM node.

Example:
node value of attribute 0 of child node 0 of xml document of file "icsxml\cmnicfg.xml" of system folder - Returns the value of the first attribute of the first node of the specified document.
Win, WM
attribute <string> of <xml dom node>Returns the named attribute of the specified node.

Example:
node value of attribute "xmlns" of child node 1 of xml document of (file "icsxml\cmnicfg.xml" of system folder) - Returns the value of the named attribute (xmlns) of the specified file.
Win, WM
attribute of <xml dom node>Returns the attribute(s) of the specified XML DOM node.

Example:
node names of attributes of child nodes of xml document of file "icsxml\cmnicfg.xml" of system folder - Returns the names of the attributes of each node in the specified file.
Win, WM
child node <integer> of <xml dom node>Returns the child node by number.

Example:
node names of child nodes of child node 1 of xml document of file "icsxml\cmnicfg.xml" of system folder - Returns a list of the names of the children of the first node in the specified document.
Win, WM
child node of <xml dom node>By chaining this Inspector, you can find the child nodes of any given node.

Example:
node names of child nodes of child node 1 of last child of xml document of file "icsxml\cmnicfg.xml" of system folder - Returns the names of the specified chain of child nodes.
Win, WM
first child of <xml dom node>Returns the first child node in the specified node. When applied to an XML DOM file, it returns the first node in the file.Win, WM
last child of <xml dom node>Returns the last child node in the specified node. When applied to an XML DOM file, it returns the last node in the file.Win, WM
next sibling of <xml dom node>Returns the next child node after the current one.

Example:
node name of next sibling of first child of xml document of file "icsxml\cmnicfg.xml" of system folder - Returns the name of the second node of the specified file.
Win, WM
parent node of <xml dom node>Returns the parent node of the specified node.Win, WM
previous sibling of <xml dom node>Returns the child node before the one specified.Win, WM
select <string> of <xml dom node>Uses an Xpath string to specify an XML DOM node. For instance, to select all elements BBB which are children of the root element AAA, use:selects "/AAA/BBB" of xml dom document <string>.Win, WM
xpath <( string, string )> of <xml dom node>The iterated named property xpaths (<namespace>, <query>) provides a way of specifying the namespaces for the query. If the XML document you are querying over uses namespaces, you must use them in the query and use this property.

Example:
xpath ( "xmlns:a='x-schema:bookschema.xml'", "/a:Books/a:Book" ) of xml document of file "c:\test.xml" as xml - Returns an xml dom node such as <a:Book xmlns:a="x-schema:bookschema.xml">%0d%0a%09<title>Presenting XML</title>%0d%0a%09<author>Richard Light</author>%0d%0a</a:Book>.
Win, WM
xpath <string> of <xml dom node>Returns an iterated list of matching xml dom nodes, given the xpath query specified by <string>.Win, WM

Properties

DeclarationReturn typeDescriptionPlatforms (?)
<xml dom node> as text<string>Casts an xml document object module node as text.Win, WM
<xml dom node> as xml<string>Casts an xml document object module node as xml.Win, WM
attribute <integer> of <xml dom node><xml dom node>

Plural: attributes
Returns the numbered attribute of the specified XML DOM node.Win, WM
attribute <string> of <xml dom node><xml dom node>

Plural: attributes
Returns the named attribute of the specified node.Win, WM
attribute of <xml dom node><xml dom node>

Plural: attributes
Returns the attribute(s) of the specified XML DOM node.Win, WM
child node <integer> of <xml dom node><xml dom node>

Plural: child nodes
Returns the child node by number.Win, WM
child node of <xml dom node><xml dom node>

Plural: child nodes
By chaining this Inspector, you can find the child nodes of any given node.Win, WM
first child of <xml dom node><xml dom node>

Plural: first children
Returns the first child node in the specified node. When applied to an XML DOM file, it returns the first node in the file.Win, WM
last child of <xml dom node><xml dom node>

Plural: last children
Returns the last child node in the specified node. When applied to an XML DOM file, it returns the last node in the file.Win, WM
next sibling of <xml dom node><xml dom node>

Plural: next siblings
Returns the next child node after the current one.Win, WM
node name of <xml dom node><string>

Plural: node names
Returns the name of the specified XML DOM node as a string.Win, WM
node type of <xml dom node><integer>

Plural: node types
Returns the numeric node type of the specified Document Object Module (DOM) node, 1-12 as shown in the creation Inspector.Win, WM
node value of <xml dom node><string>

Plural: node values
Returns the node value, which varies depending on the node type. If the standard interface produces a null type, the Inspector throws NoSuchObject.Win, WM
owner document of <xml dom node><xml dom document>

Plural: owner documents
Returns a document belonging to the owner of the specified node.Win, WM
parent node of <xml dom node><xml dom node>

Plural: parent nodes
Returns the parent node of the specified node.Win, WM
previous sibling of <xml dom node><xml dom node>

Plural: previous siblings
Returns the child node before the one specified.Win, WM
select <string> of <xml dom node><xml dom node>

Plural: selects
Uses an Xpath string to specify an XML DOM node. For instance, to select all elements BBB which are children of the root element AAA, use:selects "/AAA/BBB" of xml dom document <string>.Win, WM
xpath <( string, string )> of <xml dom node><xml dom node>

Plural: xpaths
The iterated named property xpaths (<namespace>, <query>) provides a way of specifying the namespaces for the query. If the XML document you are querying over uses namespaces, you must use them in the query and use this property.Win, WM
xpath <string> of <xml dom node><xml dom node>

Plural: xpaths
Returns an iterated list of matching xml dom nodes, given the xpath query specified by <string>.Win, WM

symlink

Symlinks, or symbolic links, are the Unix version of shortcut files (pointers to other files). Inspectors can analyze the file objects (files and folders) that symlinks point to by using the standard file Inspectors. The symlink Inspectors, on the other hand, allow you to analyze the properties of a symlink itself, not just the underlying file. There are many properties that symlinks have in common with files, such as name, pathname, parent folder, and more. In addition, a symlink has a value corresponding to the file object it points to. You can also determine if the file is available or not.

Creation Methods

DeclarationDescriptionPlatforms (?)
symlink <filesystem object>Returns a symlink from the specified filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1
symlink <string>Returns a symlink from the specified string.Lin, Sol, HPUX, AIX, Ubu:8.1
symlink <symlink>Returns a symlink from the specified symlink path, even if the symlink is broken.Lin, Sol, HPUX, AIX, Ubu:8.1
<filesystem object> as symlinkCasts a link in the form of a file into a symlink.

Example:
file "/example/link" as symlink - Returns the link (in file format) as a symlink object ("/example/link").
Lin, Sol, HPUX, AIX, Ubu:8.1
symlink <string> of <folder>Returns the named symlink from the specified folder.Lin, Sol, HPUX, AIX, Ubu:8.1
symlink of <folder>Returns the symlink(s) in the specified folder, whether or not they are broken. Note: This behavior differs from looking for files in a folder. Although that returns links along with the files, it doesn't return broken links.

Example:
symlinks of folder "/example" - Returns a list of the symlink in the specified folder, whether or not they are broken. Note that this behavior is different from looking for files in a folder -- that will return links as well as files, but won't return broken links.
Lin, Sol, HPUX, AIX, Ubu:8.1
<symlink> as symlinkCasts a symlink, provided for completeness.Lin, Sol, HPUX, AIX, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
<symlink> as device file<device file>Casts a symlink type as a device file type.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
<symlink> as fifo file<fifo file>Casts a symlink object as a fifo file.Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Ubu:8.1
<symlink> as fifo file<fifo file>Casts a symlink type as a FIFO (named pipe) file.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
<symlink> as file<file>Converts a symlink object into the file it points to.Lin, Sol, HPUX, AIX, Ubu:8.1
<symlink> as folder<folder>Converts a symlink object into the folder it points to.Lin, Sol, HPUX, AIX, Ubu:8.1
<symlink> as socket file<socket file>Casts a symlink type as a socket file type.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
<symlink> as string<string>Casts a symlink object as a string.Lin, Sol, HPUX, AIX, Ubu:8.1
<symlink> as symlink<symlink>Casts a symlink, provided for completeness.Lin, Sol, HPUX, AIX, Ubu:8.1
accessed time of <symlink><time>

Plural: accessed times
Returns the last accessed time of the specified symlink.Lin, Sol, HPUX, AIX, Ubu:8.1
ancestor of <symlink><folder>

Plural: ancestors
Returns all ancestor folders (recursive parent folders) of the given symlink.Lin, Sol, HPUX, AIX, Ubu:8.1
change time of <symlink><time>

Plural: change times
Returns the last time the specified symlink was 'changed' by either writing it or setting its inode information.Lin, Sol, HPUX, AIX, Ubu:8.1
drive of <symlink><filesystem>

Plural: drives
Returns the drive associated with the specified symlink as a <filesystem> object.Lin, Sol, HPUX, AIX, Ubu:8.1
filesystem of <symlink><filesystem>

Plural: filesystems
Returns the filesystem on which the symlink resides.Lin, Sol, HPUX, AIX, Ubu:8.1
gid of <symlink><integer>

Plural: gids
Returns the group ID of the given symlink.Lin, Sol, HPUX, AIX, Ubu:8.1
group name of <symlink><string>

Plural: group names
Returns the group name of the specified symlink.Lin, Sol, HPUX, AIX, Ubu:8.1
link count of <symlink><integer>

Plural: link counts
Returns an integer corresponding to the number of hard links attached to the specified symlink.Lin, Sol, HPUX, AIX, Ubu:8.1
location of <symlink><string>

Plural: locations
Returns a string corresponding to the directory in which the symlink is located.Lin, Sol, HPUX, AIX, Ubu:8.1
modification time of <symlink><time>

Plural: modification times
Returns the time corresponding to the modification time of the specified symlink, not the file it points to.Lin, Sol, HPUX, AIX, Ubu:8.1
name of <symlink><string>

Plural: names
Returns a string that is the full pathname of the specified symlink.Lin, Sol, HPUX, AIX, Ubu:8.1
parent folder of <symlink><folder>

Plural: parent folders
Creates a folder object corresponding to the parent folder of the given symlink.Lin, Sol, HPUX, AIX, Ubu:8.1
pathname of <symlink><string>

Plural: pathnames
Returns a string that contains the full pathname of the specified symlink.Lin, Sol, HPUX, AIX, Ubu:8.1
uid of <symlink><integer>

Plural: uids
The user ID of the user who owns this symlink.Lin, Sol, HPUX, AIX, Ubu:8.1
user name of <symlink><string>

Plural: user names
Returns the symlink owner's (user's) name.Lin, Sol, HPUX, AIX, Ubu:8.1
value accessible of <symlink><boolean>

Plural: values accessible
Returns TRUE if the pathname pointed to by the specified symlink is available. Returns FALSE if the file object is missing or unavailable with the current permissions.Lin, Sol, HPUX, AIX, Ubu:8.1
value of <symlink><string>

Plural: values
Returns the pathname that the symlink points to.Lin, Sol, HPUX, AIX, Ubu:8.1

logical volume manager

On AIX, the logical volume manager provides a flexible means of allocating disk space using volume groups, logical volumes, and physical volumes. A volume group is a collection of one or more physical volumes and a logical volume is an abstraction representing a pool of disk space. The disk space assigned to a logical volume appears contiguous to the user, but it may actually be distributed across one or more physical volumes within a single volume group.

Creation Methods

DeclarationDescriptionPlatforms (?)
logical volume managerReturns the global logical volume manager on AIX systems.AIX

Properties

DeclarationReturn typeDescriptionPlatforms (?)
volume group <string> of <logical volume manager><volume group>

Plural: volume groups
On an AIX system, returns a volume group from the logical group whose name property matches the given string.AIX
volume group of <logical volume manager><volume group>

Plural: volume groups
Returns the volume group corresponding to the given logical volume manager.AIX

logical volume

A logical volume consists of an array of identically sized logical partitions. The partition size of a logical volume is determined by the volume group that contains it, and is the same as the volume group's physical partition size. Contiguous logical partitions within a logical volume may map to discontiguous physical partitions, possibly distributed across multiple physical volumes. A logical volume may be configured so that its logical partitions are mirrored to protect data from hardware failures. Mirroring may be configured so that each logical partition maps to either 2 or 3 physical partition mirrors.

Creation Methods

DeclarationDescriptionPlatforms (?)
logical volume of <filesystem>On an AIX system, returns the logical volume corresponding to the given filesystem.AIX
logical volume <string> of <volume group>Returns a logical volume within the specified volume group whose "name" property matches the given string.AIX
logical volume of <volume group>On an AIX system, returns the logical volume corresponding to the specified volume group.

Example:
logical volumes of volume group "joe" of logical volume manager - Returns a list of the logical volumes in the specified volume group.

Example:
number of logical volumes of volume group "dave" of logical volume manager - Returns the number of logical volumes in the specified volume group.

Example:
logical volumes of volume groups of logical volume manager - Returns the list of all the logical volumes in the logical volume manager.
AIX

Properties

DeclarationReturn typeDescriptionPlatforms (?)
<logical volume> as string<string>Casts an AIX logical volume as a string type.AIX
label of <logical volume><string>

Plural: labels
Returns the label of the specified logical volume. If the logical volume contains a filesystem, then then this will be the full pathname of the mount point of the file system, eg. "/home".AIX
maximum partition count of <logical volume><integer>

Plural: maximum partition counts
Returns the maximum number of logical partitions that the specified logical volume contains. A system administrator may set this value to prevent a logical volume from growing beyond a given size.AIX
minor number of <logical volume><integer>

Plural: minor numbers
Returns the minor number of the specified volume group. Each logical volume is represented by a device special file (located in directory /etc). The major number of the device special file is associated with the volume group containing the logical volume, and the minor number of the device special file is associated with the logical volume.AIX
mirror count of <logical volume><integer>

Plural: mirror counts
Returns the number of mirrors that the logical volume has (a value between 1 and 3).AIX
name of <logical volume><string>

Plural: names
On an AIX system, returns the name of the logical volume, eg. "hd1".AIX
partition count of <logical volume><integer>

Plural: partition counts
Returns the number of partitions in the specified logical volume. If mirroring is not enabled for the logical volume, then each logical partition maps to a physical partition within the logical volume's volume group. If the logical volume is mirrored, then each logical partition maps to multiple physical partitions within the logical volume group. In this case, the total number of physical partitions occupied by the logical volume will be the product of the partition count and the mirror count.AIX
volume group of <logical volume><volume group>

Plural: volume groups
Returns the volume group that contains the given logical volume.AIX

volume group

On AIX systems, physical disk volumes are organized into volume groups. The partition size of a physical volume is determined by the volume group that it belongs to. If multiple physical volumes belong to the same volume group, then they must all have the same partition size. A typical partition size might be 16 or 32 megabytes.

Creation Methods

DeclarationDescriptionPlatforms (?)
volume group <string> of <logical volume manager>On an AIX system, returns a volume group from the logical group whose name property matches the given string.AIX
volume group of <logical volume manager>Returns the volume group corresponding to the given logical volume manager.

Example:
number of volume groups of logical volume manager - Returns the number of volume groups in the global logical volume manager.
AIX
volume group of <logical volume>Returns the volume group that contains the given logical volume.

Example:
volume group of logical volume "splat" of volume group "dave" of logical volume manager - Returns the name of the volume group corresponding to the specified volume, in this case, "dave".
AIX

Properties

DeclarationReturn typeDescriptionPlatforms (?)
<volume group> as string<string>Casts an AIX volume group as a string type.AIX
free partition count of <volume group><integer>

Plural: free partition counts
Returns the number of physical partitions within the specified volume group that are not currently allocated to any logical volume.AIX
logical volume <string> of <volume group><logical volume>

Plural: logical volumes
Returns a logical volume within the specified volume group whose "name" property matches the given string.AIX
logical volume of <volume group><logical volume>

Plural: logical volumes
On an AIX system, returns the logical volume corresponding to the specified volume group.AIX
major number of <volume group><integer>

Plural: major numbers
Returns the major number of the specified volume group. Each logical volume is represented by a device special file (located in directory /etc). The major number of the device special file is associated with the volume group containing the logical volume, and the minor number of the device special file is associated with the logical volume.AIX
name of <volume group><string>

Plural: names
Returns the name of the volume group, eg. "rootvg".AIX
partition size of <volume group><integer>

Plural: partition sizes
Returns the partition size of the specified volume group (in bytes). The partition size of the volume group represents the logical and physical partition sizes for all logical volumes and physical volumes contained within the specified volume group.AIX

download storage folder

Before an Action executes, the download storage folder points to a temporary directory that holds the downloads for the Action. During execution of the Action, those downloads are moved to the standard BigFix __Download folder and the Inspector then points there. These Inspectors return information about the currently specified download storage folder, and can be used with relevance substitution in download and prefetch Action commands.

Creation Methods

DeclarationDescriptionPlatforms (?)
download storage folderThis Inspector creates a pointer to the current download storage folder.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
total size of <download storage folder><integer>

Plural: total sizes
Returns the amount of storage currently being used to store downloads (in bytes).Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1

device file

These Inspector types interrogate Unix-style device files, which contain device drivers or system resources. Unix identifies these resources by a major number and a minor number, both stored as part of a node structure. Typically, the major number identifies the device driver and the minor number identifies the particular device controlled by that driver.

Creation Methods

DeclarationDescriptionPlatforms (?)
device file <filesystem object>Returns the device file indicated by the specified filesystem object.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
device file <string>Returns the device file with the specified name.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
device file <symlink>Returns the device file specified by the supplied symbolic link.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
<filesystem object> as device fileReturns a device file or nothing (if the filesystem object specified is not a device file).Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
device file <string> of <folder>Returns the device file with the specified name in the given folder.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
device file of <folder>Returns the device files that exist in the specified folder.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
<symlink> as device fileCasts a symlink type as a device file type.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
device type of <device file><string>

Plural: device types
Returns the device type corresponding to the give device file, as a string.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
drive of <device file><filesystem>

Plural: drives
Returns the drive associated with the specified device file.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
filesystem of <device file><filesystem>

Plural: filesystems
Returns the filesystem object corresponding to the specified device file.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
major of <device file><integer>

Plural: majors
Returns the major number of the specified device file.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
minor of <device file><integer>

Plural: minors
Returns the minor number of the specified device file.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1

fifo file

In Unix systems, a FIFO file is a named pipe that uses the file system as a way to store the pipe name. These Inspectors provide access to these named pipes.

Creation Methods

DeclarationDescriptionPlatforms (?)
fifo file <filesystem object>Returns the FIFO file (named pipe) described by the specified filesytem object.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
fifo file <string>Returns the FIFO file (named pipe) with the given name.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
fifo file <symlink>Returns the FIFO file (named pipe) described by the specified symbolic link (symlink).Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
<filesystem object> as fifo fileReturns a FIFO file or nothing (if the filesystem object specified is not a FIFO file).Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
fifo file <string> of <folder>Returns the FIFO file (named pipe) with the given name in the specified folder.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
fifo file of <folder>Returns the list of FIFO file in the given folder.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
<symlink> as fifo fileCasts a symlink object as a fifo file.Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Ubu:8.1
<symlink> as fifo fileCasts a symlink type as a FIFO (named pipe) file.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
drive of <fifo file><filesystem>

Plural: drives
Returns the drive associated with the specified FIFO (named pipe) file.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
filesystem of <fifo file><filesystem>

Plural: filesystems
Returns the filesystem object corresponding to the specified FIFO file.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1

socket file

The <socket file> Inspectors allow you to interrogate socket files, which are representations of UNIX domain sockets identified by their pathname.

Creation Methods

DeclarationDescriptionPlatforms (?)
socket file <filesystem object>Returns the socket file(s) indicated by the supplied filesystem object.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
socket file <string>Returns the named socket file.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
socket file <symlink>Returns the socket file(s) indicated by the supplied symlink.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
<filesystem object> as socket fileCasts a given filesystem object as a socket file.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
socket file <string> of <folder>Returns the socket file with the given name in the specified folder.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
socket file of <folder>Returns the socket file(s) in the specified folder.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
<symlink> as socket fileCasts a symlink type as a socket file type.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
drive of <socket file><filesystem>

Plural: drives
Returns the drive associated with the specified socket file.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
filesystem of <socket file><filesystem>

Plural: filesystems
Returns the filesystem object corresponding to the specified socket file.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1